Chucky CLI


Command-line interface for deploying AI agent workspaces to the Chucky cloud platform. Build and ship Claude-powered assistants with ease.

Installation

``bash
npm install -g @chucky.cloud/cli
`

Quick Start

`bash


Authenticate with your Chucky account

chucky login

Initialize a new project

chucky init

Deploy your workspace

chucky deploy
`

Commands

$3

Authenticate with your Chucky account using browser-based device flow or API key.

`bash


Interactive browser-based login (recommended)

chucky login

Direct API key authentication

chucky login -k ak_live_xxxxx
`

Options:
- -k, --key - Skip browser flow and authenticate with API key directly

$3

List all projects in your account.

`bash
chucky list
`

Displays project name, ID, status, and HMAC key for each project.

$3

Initialize a new Chucky project in the current directory.

`bash
chucky init
`

What it does:
1. Creates or selects an existing project
2. Prompts for project name and description
3. Optionally configures Anthropic API key
4. Saves .chucky.json configuration file
5. Optionally sets up GitHub Actions workflow

$3

Deploy your workspace to the Chucky cloud.

`bash


Deploy using config from .chucky.json

chucky deploy

Deploy a specific folder

chucky deploy -f ./my-workspace
`

Options:
- -f, --folder - Override the folder to deploy

Deployment flow:
1. Creates tar.gz archive of workspace folder
2. Uploads to Chucky cloud storage (R2)
3. Marks workspace as deployed
4. Displays example code for generating tokens

$3

Display the HMAC key for the current project.

`bash
chucky keys
`

$3

Set the Anthropic API key for a project.

`bash


Interactive prompt

chucky config anthropic

Direct key input

chucky config anthropic -k sk-ant-xxxxx
`

Options:
- -k, --key - Anthropic API key to set

$3

Delete a project.

`bash


Delete from selection list

chucky delete

Delete specific project

chucky delete PROJECT_ID
`

Configuration

$3

Stores user credentials:
`json
{
"apiKey": "ak_live_...",
"email": "user@example.com",
"portalUrl": "https://app.chucky.cloud"
}
`

$3

Stores project-specific settings:
`json
{
"projectId": "uuid-...",
"projectName": "my-project",
"folder": "./workspace",
"hmacKey": "hk_live_..."
}
`

Environment Variables

- CHUCKY_API_KEY - Override API key from config
- CHUCKY_PORTAL_URL - Override portal URL (for development)

Authentication Flow

$3

1. CLI generates a device code and opens browser
2. User signs in to Chucky portal
3. User confirms the device code
4. CLI receives API key and stores locally

$3

1. User obtains API key from Chucky portal
2. User runs chucky login -k ak_live_...
3. CLI validates key and stores locally

Workspace Deployment

$3

The following are excluded from deployment archives:
- node_modules/
- .git/
- .env files
- dist/, build/
- Cache and log directories

$3

Workspaces are compressed as .tgz (tar.gz) with maximum compression.

Dependencies

- commander - CLI framework
- inquirer - Interactive prompts
- chalk - Terminal styling
- ora - Progress spinners
- archiver - Archive creation

Development

`bash


Install dependencies

npm install

Build TypeScript

npm run build

Watch mode

npm run dev

Type checking only

npm run typecheck
``

License

MIT