Sign up
- Open the Akter Cloud console. Enter your name, email and a password of at least 12 characters, and accept the Terms of Service and Privacy Policy.
- Open the verification link sent to your email address. A verified account is required to use the Cloud API and approve CLI login.
- Follow onboarding to name your organization and create your first project. Organizations own projects, members and billing; projects contain environments and deployments.
- Keep your project’s ID for
--project, or setAKTER_PROJECTin your shell. The CLI needs the ID, not the project name or slug.
Install the CLI
The package is@rikalabs/akter-cli; its executable is akter. It supports Bun 1.4.2+ or Node 24+.
Use the alpha dist-tag for both packages: @rikalabs/akter-cli@alpha for the CLI and @rikalabs/akter@alpha for your app, as in the quickstart. The framework’s latest tag may still point to an older alpha.
- Bun
- Node / npm
login prints a browser URL and an eight-character code. Open that URL, sign in and approve the matching code. Wait for the CLI to confirm that it saved your credentials. Never share the code or credential file.
For a preview or another control plane, use its API URL explicitly:
--api-url, not --api. AKTER_API_URL also selects the API for login. Otherwise, login uses https://api.akter.dev. Subsequent commands use the API saved by login, not a newly changed AKTER_API_URL. Remote APIs must use HTTPS; HTTP is accepted only for loopback hosts.
whoami prints your email, organization slugs, roles and organization IDs. Credentials are stored in the platform’s configuration directory; AKTER_CONFIG_DIR overrides that location. On macOS the default is ~/Library/Application Support/akter. Do not commit this directory.
Connect Postgres before deploying
Choose a Postgres near the runners in Flyiad / AWS us-east-1, then set its direct connection URL as DATABASE_URL in each environment you will deploy. This is required on Free, Pro, Team and Enterprise. Transaction-pooler URLs are refused; a deploy-time p50 latency above 5 ms warns but does not block deployment.
Next, deploy your app and review compute-only pricing and limits. You own the database’s capacity, backups and provider bill, and Akter never deletes it. See environment variables for your other configuration.