CLI
Installation
Install and configure the Aidelly CLI.
Install
Global install (recommended):
npm install -g @aidelly/cliPer-project:
npm install --save-dev @aidelly/cliWithout installing:
npx @aidelly/cli <command>Verify installation
aidelly --versionConfiguration
Environment variables
The CLI reads the following environment variables:
| Variable | Required | Description |
|---|---|---|
AIDELLY_API_KEY | Yes | Your Aidelly API key |
AIDELLY_WORKSPACE_ID | No | Default workspace UUID |
AIDELLY_BRAND_ID | No | Default brand UUID |
AIDELLY_API_BASE | No | API base URL (default: https://app.aidelly.ai/api/public/v1) |
Set them in your shell profile:
# ~/.zshrc or ~/.bashrc
export AIDELLY_API_KEY=aidelly_live_xxx
export AIDELLY_WORKSPACE_ID=your-workspace-uuid
export AIDELLY_BRAND_ID=your-brand-uuidInteractive login
aidelly auth loginThis stores credentials in ~/.aidelly/config.json.
Verify credentials
aidelly auth whoamiGenerating an API key
- Go to Settings → API Keys in your Aidelly dashboard
- Click New Key
- Give it a name (e.g.,
cli-local) - Select scopes:
posts:write,posts:read(add others as needed) - Copy the key — it's shown only once
API access requires an active paid plan.