claudable Documentation

Claude Code is the recommended AI agent for Claudable. It provides deep codebase awareness and direct terminal integration.

Installation:

1. Install the package globally via npm.
2. Run the claude command and follow the /login prompt to authenticate.

npm install -g @anthropic-ai/claude-code
claude  # then > /login

To enable deployment and database features, connect your accounts in the Claudable Settings under Service Integrations.

GitHub Integration:

• Generate a Classic Personal Access Token at GitHub settings.
• Ensure the token has the repo scope.

Vercel Integration:

• Create a token in your Vercel Account Settings.

Supabase Integration:

• Obtain your Project URL, Anon Key, and Service Role Key from your Supabase Dashboard (Settings → API).

Codex CLI is an OpenAI-powered agent with high reasoning capabilities. It supports interactive, auto-edit, and full-auto operating modes.

Installation:

1. Install the package globally via npm.
2. Run the codex command and login with your ChatGPT account.

npm install -g @openai/codex
codex  # login with ChatGPT account

Cursor CLI is a multi-model AI agent that supports Anthropic and OpenAI models, as well as AGENTS.md support.

Installation:

1. Install via the official curl script.
2. Run cursor-agent login to authenticate.

curl https://cursor.com/install -fsS | bash
cursor-agent login

You can run Claudable as a desktop application for macOS, Windows, or Linux using the following commands:

• Development mode: Run the desktop version in dev mode.
• Build: Compile the desktop application.
• Package: Create platform-specific installers.

# Development mode
npm run dev:desktop

# Build desktop app
npm run build:desktop

# Package for specific platforms
npm run package:mac      # macOS
npm run package:win      # Windows
npm run package:linux    # Linux

Qwen Code is an open-source CLI for Qwen3-Coder models from Alibaba, offering large context windows (up to 1M tokens).

npm install -g @qwen-code/qwen-code@latest
qwen --version

To get Claudable running on your local machine, clone the repository, install dependencies, and start the development server. The application will be available at http://localhost:3000 (or the next available port if 3000 is occupied).

Prerequisites:

• Node.js 18+
• Claude Code or Cursor CLI (already logged in)
• Git

# Clone the repository
git clone https://github.com/opactorai/Claudable.git
cd Claudable

# Install all dependencies
npm install

# Start development server
npm run dev

Claudable supports several AI coding agents. Use the following commands to install them globally on your system:

• Claude Code: npm install -g @anthropic-ai/claude-code
• Codex CLI: npm install -g @openai/codex
• Cursor Agent: curl https://cursor.com/install -fsS | bash
• Qwen Coder: npm install -g @qwen-code/qwen-code
• GLM CLI: zai devpack install claude

If you encounter the error Error output dangerously skip permissions cannot be used which is root sudo privileges for security reasons, follow these steps:

1. Do not run Claude Code with sudo or as root.
2. Fix file ownership in WSL:

   sudo chown -R $(whoami):$(whoami) ~/Claudable

3. Reinstall Claude Code without sudo:

   npm install -g @anthropic-ai/claude-code --unsafe-perm=false

The encryption utilities rely on the ENCRYPTION_KEY environment variable to derive the AES-256-CBC key.

• Requirement: To ensure that data encrypted during one execution can be decrypted in a later execution, you must provide a consistent key.
• Behavior: If ENCRYPTION_KEY is absent, the library generates a random key using crypto.randomBytes(32).toString('hex'). This makes the encryption non-persistent across process restarts.

Global settings allow you to define a defaultCli and specific configurations for each supported CLIType. Use the cliSettings object to map a CLIType to its specific model or other configuration parameters.

export interface GlobalSettings {
  defaultCli?: CLIType;
  cliSettings?: {
    [key in CLIType]?: {
      model?: string;
      [key: string]: any;
    };
  };
}

Use these commands to manage the local SQLite database and clean up your environment.

Database Commands:

• npm run db:backup: Creates a backup of the SQLite database in data/backups/cc_backup_[timestamp].db.
• npm run db:reset: Resets the database to its initial state (Warning: deletes all data).
• npm run prisma:reset: Drops and recreates the database to match the latest schema (useful for migration conflicts).

Maintenance Commands:

• npm run clean: Removes node_modules/ and package-lock.json for a fresh start.