Foan CLI
The public Foan CLI lets you work with your agents, campaigns, calls and balance from a terminal. You will need Node.js 20 or newer and a Foan login with the appropriate access.
1. Install the command
Section titled “1. Install the command”npm install -g foan-aifoan --help2. Sign in
Section titled “2. Sign in”foan loginfoan whoamiThe first command opens your browser to sign in. The second shows the account and organisation you will use. On a machine without a browser, foan login --no-browser prints the sign-in link to open elsewhere.
3. Read your account
Section titled “3. Read your account”foan agents listfoan calls listfoan walletRun foan <command> --help for a command’s options. Add --json when your own script needs structured output. Check the selected organisation before commands that change anything, spend credits or start calls.
4. Sign out when finished
Section titled “4. Sign out when finished”foan logoutFor unattended scripts, use an appropriately scoped API key through the FOAN_API_KEY environment variable. Keep it in your own secret store, never in a shared script or a chat message.