CLI Overview

The Inconvo CLI lets you manage semantic models and database connections directly from your terminal. It’s designed to work alongside coding agents like Claude Code and Cursor.

Installation

npm install -g @inconvoai/cli

Or use it via npx without installing globally:

npx inconvo --help

Authentication

The CLI uses your Inconvo API key for authentication. Set it as an environment variable:

export INCONVO_API_KEY=your_api_key_here

Or pass it directly to any command:

npx inconvo model pull --api-key your_api_key_here

Command Reference

Command	Description
inconvo model pull	Pull semantic model files into .inconvo/ for one or more agents
inconvo model agent list	List agents available in your organisation
inconvo model action run	Run a model action from a raw JSON payload
inconvo model action schema	List supported model actions and metadata
inconvo model table	Manage table settings (queryable, joinable, off)
inconvo model column	Manage column settings (on/off)
inconvo model computed	Manage computed columns
inconvo model relation	Manage relations between tables
inconvo model condition	Manage conditions on tables
inconvo model policy	Manage policies
inconvo model virtual	Manage virtual tables
inconvo model user-context	Manage user context configuration
inconvo connection get	Show metadata for a connection
inconvo connection list	List connections for an agent
inconvo connection sync	Trigger a full database resync for a connection
inconvo connection update	Update a connection description

Typical Workflow

# 1. Pull your semantic model
npx inconvo model pull

# 2. Make changes via your coding agent or the mutation commands
# 3. Sync changes back
npx inconvo connection sync --agent agt_123

For detailed documentation on each command group, see:

Model Commands Pull, inspect, and mutate your agent's semantic model.

Connection Commands Manage database connections and trigger resyncs.