Skip to main content
The ChameleonDB CLI provides commands for managing database schemas, migrations, and integrity verification.

Installation

Linux and macOS

Windows

Download the compressed .gz file from chameleondb.dev/windows. Extract to get:
  • chameleon.exe
  • chameleon.dll
Both files must be kept together. Add to PATH to use in any terminal.

Verify Installation

Environment Variables

string
Database connection string. Used by migrate, status, and introspect commands.Example:

Command Categories

Project Initialization

Schema Management

Integrity & Monitoring

Configuration

Utility Commands

  • chameleon version - Show ChameleonDB version
  • chameleon check [file] - Check schema for errors (for editor integrations)
  • chameleon query [entity] - Interactive query execution (for testing)
  • chameleon uninstall - Uninstall ChameleonDB from system

Project Structure

After running chameleon init, you’ll have:

Common Workflows

First-Time Setup

Daily Development

Integrity Verification

Global Flags

boolean
default:"false"
Enable verbose output with additional debug information
boolean
Show help for any command
boolean
Show CLI version

Exit Codes

  • 0 - Success
  • 1 - General error
  • Non-zero - Command-specific error

Getting Help

Next Steps

Initialize Project

Create a new ChameleonDB project

Run Migrations

Apply schema changes to database

Verify Integrity

Check Schema Vault integrity

View Audit Logs

Explore operation history