Skip to main content

The gateway package (@permaura/gateway)

@permaura/gateway is the one-command way to install and run the gateway. It is a thin npx wrapper: it downloads the self-contained gateway binary, starts it on loopback, and (optionally) pairs it to your permaura.com account.

This is different from perma: @permaura/gateway runs the gateway; perma controls a gateway that is already running.

Install and run

# install and start the gateway on 127.0.0.1:8787
npx @permaura/gateway

# install, start, and connect it to your account in one step
npx @permaura/gateway --pair PGW-XXXXXXXX

The pairing code comes from the console's "Connect a gateway" dialog. With --pair there are no tokens to copy: the gateway redeems the code and binds itself to your account. See Connect a gateway for the full onboarding walkthrough.

Options and environment

Flag / variableEffect
--pair <code>redeem a one-time pairing code and connect to your account
PERMAURA_ADDRbind address (default 127.0.0.1:8787)
PERMAURA_APIaccount API base (default https://permaura.com)
Platform

npx @permaura/gateway currently supports macOS. Linux and Windows are on the way.

What you get

Once it is running you have a live gateway on 127.0.0.1:8787. From there you can:

  • add connections (including SSH) from the console or with perma,
  • point an MCP client at http://127.0.0.1:8787/mcp,
  • drive it from the command line with the perma CLI.

The gateway is a single self-contained binary and holds your keys locally; the npm package is just the most convenient way to fetch and launch it.