Aidelly Docs
CLI

Installation

Install and configure the Aidelly CLI.

Install

Global install (recommended):

npm install -g @aidelly/cli

Per-project:

npm install --save-dev @aidelly/cli

Without installing:

npx @aidelly/cli <command>

Verify installation

aidelly --version

Configuration

Environment variables

The CLI reads the following environment variables:

VariableRequiredDescription
AIDELLY_API_KEYYesYour Aidelly API key
AIDELLY_WORKSPACE_IDNoDefault workspace UUID
AIDELLY_BRAND_IDNoDefault brand UUID
AIDELLY_API_BASENoAPI 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-uuid

Interactive login

aidelly auth login

This stores credentials in ~/.aidelly/config.json.

Verify credentials

aidelly auth whoami

Generating an API key

  1. Go to Settings → API Keys in your Aidelly dashboard
  2. Click New Key
  3. Give it a name (e.g., cli-local)
  4. Select scopes: posts:write, posts:read (add others as needed)
  5. Copy the key — it's shown only once

API access requires an active paid plan.