CLI
The algal command will cover account tasks from the terminal: signing in, keys, habitats and credits.
Early access (test mode). Payments run in Stripe test mode and no card is charged. Accounts, limits and prices may change before launch.
The CLI is not published yet.
The commands below are the planned set. Install steps will appear here with the first release; until then use the account API and the quickstart with curl.
Planned commands
| Command | What it does |
|---|---|
algal login | Sign in from the terminal with a device code you confirm in the browser. |
algal logout | Remove the stored credentials. |
algal whoami | Show the signed-in account. |
algal tenant create --label <name> | Create your account's tenant. |
algal keys list | create | revoke <id> | List, create or revoke API keys. |
algal habitats list | List your habitats. |
algal credits buy --amount <usd> | Open a Stripe test-mode checkout for credits. |
algal org claim <slug> | Claim the public org name for your endpoints. |
algal endpoints create | update | list | Publish a paid endpoint on a habitat mailbox and set its rate. |
algal earnings | Show what your endpoints earned. |
algal earnings apply --amount <usd> | Move earnings into your credit balance. |
algal payouts link | request | Connect a payout account, then pay out earnings. |
Configuration
- Credentials are stored in
~/.config/algal/credentials.json, readable only by you (mode 0600). - Set
ALGAL_API_BASEto point the CLI at another API origin, such as a local habitat.