Skip to content

CLI command map

Run bfast help for the installed command syntax. Put flags before positional arguments. Most reads support --json. The portable CLI uses HTTPS; operator-only node commands are not customer commands.

Purpose Commands
Install/update Run the public installer again
Identity bfast version, bfast login, bfast whoami --json
Catalog bfast apps list, bfast inspect --json <app>
Create bfast deploy --name <name> --tier small <project directory>
Update bfast update --app <app> <project directory>
Delete bfast delete <app>
Operation bfast operations --json <request ID>, bfast operations --wait <request ID>
Users bfast users create/list/get/verify/role/revoke-sessions/disable/enable/delete
Protected request bfast request --app <app> --email <email> --path <path>
SMTP bfast smtp set/status/clear --app <app>
Account object usage bfast storage --json
Files bfast files list --app <app>
Event work bfast events list/get/replay/skip --app <app>
Jobs bfast jobs list/run --app <app>
TypeScript client bfast sdk --app <app> --out client.ts
API contract bfast openapi --app <app> --out openapi.json

Read scope controls inspection. Write scope controls deployment, update, users, SMTP and supported work changes. Delete permission controls app deletion. These permissions are distinct. The platform checks current ownership on every request.

bfast request prompts for the app password and uses a separate app session. It does not forward the platform key to business routes. SMTP and user password commands use hidden prompts or bounded secret-manager pipes.

Use the lifecycle guide, user guide and quickstart for complete commands. The portable CLI currently does not expose the operator’s app restart or permanent volume-purge tools.