Skip to content

CLI Commands Reference

chakra-convai provides a complete suite of commands for building, checking, testing, and running your voice agent application.

Run these commands from the root directory of your application (where chakra.toml, .env, and config/ reside).


Command Summary

Command Purpose License Required?
chakra-convai init Bootstrap a new application boilerplate No (with --channels)
chakra-convai check Validate configuration, skills, prompts, and license Yes
chakra-convai console Talk to the agent directly in terminal Yes
chakra-convai dev Run local worker with auto-reload Yes
chakra-convai start Start production LiveKit worker Yes
chakra-convai prompt [LANG] Print assembled system prompt for inspect/debug Yes
chakra-convai build-rag Compile knowledge base vector index Yes
chakra-convai kb <QUESTION> Query knowledge base from CLI Yes
chakra-convai licence View active Chakra Console license details Yes
chakra-convai download-files Pre-download model weights (Docker build step) No
chakra-convai version Print engine version No

Detailed Command Descriptions

chakra-convai init [DIR] [--name NAME] [--channels phone,web_voice,web_chat] [--force]

Scaffolds a new application. - --channels: Comma-separated list of channels (phone, web_voice, web_chat). If omitted, queries Chakra Console using your CHAKRA_LICENSE_KEY. - --force: Overwrite existing files.

chakra-convai check

Performs end-to-end static validation: - Resolves and verifies chakra.toml settings. - Discovers and validates all skills and @function_tool decorators. - Verifies that greeting, silence, and daily quota lines exist in config/instructions.json for all supported languages. - Verifies the cryptographic license against Chakra Console and ensures configured channels match the project type.

chakra-convai console

Launches an interactive voice terminal session using your microphone and speakers. Allows rapid prompt and skill testing without placing phone calls or opening a web app.

chakra-convai dev

Starts the worker process locally and monitors python source files, restarting worker instances on modification.

chakra-convai start

Runs the worker in production mode, listening for incoming LiveKit SIP dispatch jobs and web rooms.

chakra-convai prompt [LANG]

Prints the compiled system prompt that the model reads at runtime for the specified language (e.g. chakra-convai prompt si), including injected tool descriptions and guidelines.

chakra-convai build-rag [--clean]

Parses documents in data/, computes embeddings, and builds the Annoy index (data/rag.ann).

chakra-convai kb <QUESTION> [LANG]

Tests knowledge retrieval directly from the terminal:

chakra-convai kb "How do I identify fall armyworm?" en

chakra-convai licence

Queries Chakra Console and displays license metadata, allowed pipelines, channel permissions, and daily caller limits.