Skip to main content
The signup CLI is published on npm and runs via npx. No installation required.

Commands

Sign up for a service

npx signup <service>
Opens a browser consent window. After approval, credentials are written to .env.

Log into the dashboard

npx signup <service> login
Authenticates with your agent token from .env and opens the service’s dashboard.

List available services

npx signup list
Shows all services registered in the Gate registry.

Flags

FlagDescription
-h, --helpShow help
-v, --versionShow version
-q, --quietSuppress non-essential output (ASCII art, next steps)
--jsonOutput results as JSON to stdout (for scripts and agents)
--registry-urlOverride the registry URL (for development)

JSON output

With --json, the CLI outputs a single JSON object to stdout on success:
{
  "status": "approved",
  "outputs": {
    "FOIL_GATE_AGENT_TOKEN": "agt_...",
    "FOIL_PUBLISHABLE_KEY": "pk_live_...",
    "FOIL_SECRET_KEY": "sk_live_..."
  },
  "env_path": "/path/to/.env",
  "docs_url": "https://usefoil.com/docs"
}
On failure:
{
  "status": "error",
  "message": "The signup was cancelled."
}
All human-readable output (steps, spinner, boxes) goes to stderr, so --json output is safe to pipe.

Environment variables

VariableDescription
SIGNUP_REGISTRY_URLOverride the default registry URL
NO_COLORDisable color output

What’s next