CLI Reference

AgenticX CLI commands and usage.

AgenticX CLI 使用指南

AgenticX 提供了功能完整的命令行工具 agx，涵盖项目创建、智能体管理、工作流编排、部署、监控等全流程操作。

5分钟快速开始

1. 安装

bash

1pip install agenticx
2agx --version

2. 创建项目

bash

1agx project create my-first-agent --template basic
2cd my-first-agent
3agx project info

3. 添加智能体

bash

1agx agent create researcher --role "Senior Research Analyst"
2agx agent list

4. 运行工作流

bash

1agx workflow create research-pipeline --agents "researcher"
2agx run workflows/research-pipeline.py --verbose

命令概览

1agx
2├── version              # 显示版本信息
3├── serve                # 启动 API 服务器
4├── run                  # 执行工作流文件
5├── validate             # 验证配置文件
6├── test                 # 运行测试套件
7│
8├── project              # 项目管理
9│   ├── create           # 创建新项目
10│   └── info             # 显示项目信息
11│
12├── agent                # 智能体管理
13│   ├── create           # 创建智能体
14│   └── list             # 列出所有智能体
15│
16├── workflow             # 工作流管理
17│   ├── create           # 创建工作流
18│   └── list             # 列出所有工作流
19│
20├── deploy               # 部署
21├── monitor              # 监控
22├── docs                 # 文档生成
23├── mineru               # 文档解析
24├── skills               # 技能注册中心
25└── hooks                # 钩子管理

serve - 启动服务器

bash

1agx serve --port 8000 --host 0.0.0.0 --reload

选项	默认值	说明
`--port`	8000	监听端口
`--host`	0.0.0.0	监听地址
`--reload`	False	开发模式热重载

project - 项目管理

project create

bash

1agx project create my-agent --template basic

模板名	说明
`basic`	基础单智能体项目
`basic_stream`	流式输出智能体项目
`a2a`	Agent-to-Agent 多智能体通信
`mcp`	MCP 协议集成项目
`knowledge`	知识库 RAG 项目

agent - 智能体管理

bash

1# 创建智能体
2agx agent create researcher --role "Research Analyst"
3
4# 交互式创建
5agx agent create my-agent --interactive
6
7# 列出智能体
8agx agent list

workflow - 工作流管理

bash

1# 创建工作流
2agx workflow create research-pipeline --template sequential
3
4# 关联多个智能体
5agx workflow create data-pipeline --template parallel --agents "agent1,agent2"
6
7# 运行工作流
8agx run workflows/my_pipeline.py --verbose

skills - 技能管理

bash

1# 列出技能
2agx skills list
3
4# 搜索技能
5agx skills search "data analysis"
6
7# 安装技能
8agx skills install web-scraper
9
10# 发布技能
11agx skills publish ./my-skill

hooks - 钩子管理

bash

1# 列出钩子
2agx hooks list
3
4# 启用/禁用钩子
5agx hooks enable user-prompt-submit
6agx hooks disable user-prompt-submit

可选依赖

依赖组	安装命令
`server`	`pip install "agenticx[server]"`
`document`	`pip install "agenticx[document]"`
`volcengine`	`pip install "agenticx[volcengine]"`
`all`	`pip install "agenticx[all]"`