Aidelly Docs
CLI

Installation

Install and configure the Aidelly CLI.

Open CLI package · Open Aidelly API Keys

  1. Check the package page for the published version's runtime requirements, then install:
npm install -g @aidelly/cli
aidelly --version
  1. Create an integration key in Aidelly API Keys and sign in:
aidelly auth login

Paste your key at the prompt. The CLI saves your profile; keep the key private. API access requires an eligible plan.

  1. Verify access and choose the workspace:
aidelly workspaces list
aidelly use workspace YOUR_WORKSPACE_ID
aidelly connections list

Environment configuration

VariablePurpose
AIDELLY_API_KEYAPI credential, when not using a saved profile
AIDELLY_WORKSPACE_IDDefault workspace ID
AIDELLY_BRAND_IDDefault brand ID
AIDELLY_API_BASEOptional API base URL override

Store secrets in your environment or secret manager. aidelly auth status shows saved profile configuration; aidelly workspaces list checks actual API access. You can also run commands without a global install using npx @aidelly/cli. Command reference