@recoupable/cli
v0.1.13
Published
Recoup platform CLI
Readme
@recoupable/cli
Command-line interface for the Recoup platform.
Quick Start
Install
npm install -g @recoupable/cliAuthenticate
Get your API key from the Recoup Developer Dashboard, then set it as an environment variable:
export RECOUP_API_KEY=your-api-keyTo persist it across sessions, add it to your shell profile:
echo 'export RECOUP_API_KEY=your-api-key' >> ~/.zshrc
source ~/.zshrcUse
~/.bashrcinstead if you use bash.
Verify
recoup whoamiCommands
Account
recoup whoami # Show your account ID
recoup whoami --json # Output as JSONArtists
recoup artists list # List your artists
recoup artists list --jsonChats
recoup chats list # List your chats
recoup chats create --name "Topic" # Create a new chat
recoup chats create --artist <id> # Create a chat with an artistSandboxes
recoup sandboxes list # List your sandboxes
recoup sandboxes create # Create a new sandbox
recoup sandboxes create --command "ls -la" # Create and run a commandOrganizations
recoup orgs list # List your organizationsGlobal Flags
All commands support --json for machine-readable JSON output.
Configuration
| Variable | Required | Description |
|----------|----------|-------------|
| RECOUP_API_KEY | Yes | Your Recoup API key |
| RECOUP_API_URL | No | API base URL (default: https://recoup-api.vercel.app) |
License
MIT
