Every behindgate command, its arguments, and global flags.

Usage

behindgate — deploy static sites privately, behind your SSO

Usage:
  behindgate login [--email <e>] [--password <p>] [--new-password <p>]
  behindgate deploy <dir> [--config <path>]
  behindgate publish <releaseId> [--config <path>]
  behindgate rollback <releaseId> [--config <path>]
  behindgate whoami
  behindgate logout
  behindgate --version

Reads behindgate.json from the current directory (tenant/site/app + environment).

The CLI reads behindgate.json from the current directory. This file identifies your tenant, site, and app, plus the environment to talk to.

Commands

login

behindgate login [--email <e>] [--password <p>] [--new-password <p>]

Signs you in. On success the CLI prints:

Signed in as {...}.

deploy

behindgate deploy <dir> [--config <path>]

Deploys the contents of the directory <dir>.

• <dir> (required) — the directory to deploy.

publish

behindgate publish <releaseId> [--config <path>]

Publishes a release.

• <releaseId> (required) — the release to publish.

If you omit the release ID, the CLI prints:

{...} needs a <releaseId>

On success it prints:

✓ {...}/{...} is live on release {...}.

rollback

behindgate rollback <releaseId> [--config <path>]

Rolls back to a release.

• <releaseId> (required) — the release to roll back to.

If you omit the release ID, the CLI prints:

{...} needs a <releaseId>

On success it prints:

Rolled back

whoami

behindgate whoami

Shows your current sign-in status. If you are not signed in, the CLI prints:

Not logged in.

logout

behindgate logout

Signs you out. On success the CLI prints:

Logged out.

Global flags

Flag	Short	Type
--config		string
--email		string
--help	-h	boolean
--new-password		string
--password		string
--version		boolean

Configuration file

The CLI reads behindgate.json from the current directory. It supports these fields:

Field	Type
apiBaseUrl	string
appId	string
auth.region	string
auth.userPoolClientId	string
auth.userPoolId	string
siteId	string
tenantId	string

You can point the CLI at a different file with --config <path>.

Messages

The CLI may also print these messages:

Unknown command: {...} {...}

✓ {...} {...}/{...} to {...}.

Error: {...}