CLI Reference
AgenticX CLI commands and usage.
AgenticX CLI Guide
agx is the Typer CLI in agenticx/cli/main.py. Daily commands are serve, studio, config, skills, hooks, feishu. Scaffold groups (project / agent / workflow) exist — run agx --help for the live list.
5-minute start
bash
1pip install agenticx2agx version3agx serve --host 127.0.0.1 --port 80004# another terminal: REPL5agx studio
Optional scaffold (separate from Near):
bash
1agx project create my-first-agent --template basic2agx agent create researcher --role "Senior Research Analyst"
Command groups
Daily:
| Command | What it starts |
|---|---|
agx serve | Studio FastAPI (create_studio_app) |
agx studio | Terminal REPL |
agx feishu | Feishu long connection |
agx gateway | IM webhook gateway |
agx config | ~/.agenticx/config.yaml |
agx skills / agx hooks | Skills and hooks |
Also present: project, agent, workflow, deploy, monitor, docs, mineru, cc-bridge, sandbox. Confirm with agx --help.
serve - Start Server
bash
1agx serve --port 8000 --host 0.0.0.0 --reload
| Option | Default | Description |
|---|---|---|
--port | 8000 | Listen port |
--host | 0.0.0.0 | Listen address |
--reload | False | Hot reload in dev mode |
project - Project Management
project create
bash
1agx project create my-agent --template basic
| Template | Description |
|---|---|
basic | Basic single-agent project |
basic_stream | Streaming output agent project |
a2a | Agent-to-Agent multi-agent communication |
mcp | MCP protocol integration project |
knowledge | Knowledge base RAG project |
agent - Agent Management
bash
1# Create agent2agx agent create researcher --role "Research Analyst"34# Interactive create5agx agent create my-agent --interactive67# List agents8agx agent list
workflow - Workflow Management
bash
1# Create workflow2agx workflow create research-pipeline --template sequential34# Attach multiple agents5agx workflow create data-pipeline --template parallel --agents "agent1,agent2"67# Run workflow8agx run workflows/my_pipeline.py --verbose
skills - Skills Management
bash
1# List skills2agx skills list34# Search skills5agx skills search "data analysis"67# Install skill8agx skills install web-scraper910# Publish skill11agx skills publish ./my-skill
hooks - Hook Management
bash
1# List hooks2agx hooks list34# Enable/disable hooks5agx hooks enable user-prompt-submit6agx hooks disable user-prompt-submit
Optional Dependencies
| Extra | Install command |
|---|---|
server | pip install "agenticx[server]" |
document | pip install "agenticx[document]" |
volcengine | pip install "agenticx[volcengine]" |
all | pip install "agenticx[all]" |