Skip to Content

Modem CLI

modem-cli manages projects, products, credentials, customers, subscription relays, backups and request logs. Commands use the same admin API and permissions as the admin SDK.

Build from source

Use the existing modem-sdk repository  checkout with package access configured and workspace dependencies installed. From its root:

bunx turbo run build --filter=@preternatural/modem-cli... ./apps/modem-cli/build/modem-cli --help

Place apps/modem-cli/build/modem-cli on your PATH to invoke it as modem-cli. For source development, run bun run dev --help from apps/modem-cli; the repository root has no dev script. Use compatible workspace/package versions when building—the CLI loads its SDK/provider dependencies before parsing commands.

The instructions here describe the current source command set. They do not require an assumed public npm binary distribution. Check your installed build with modem-cli --version and the relevant --help before using recently added provider commands.

Log in

modem-cli auth login --web modem-cli projects list

The browser approval creates a key for the selected deployment. Prefer scoped access for automation. On a remote machine, use an existing key through stdin instead; see authentication.

Choose a workflow

Last updated on