CrewAI 命令行界面文档

CrewAI CLI 提供了一组命令来与 CrewAI 进行交互,允许您创建、训练、运行和管理 crews 和 flows。

安装

要使用CrewAI CLI,请确保已安装CrewAI:

pip install crewai

基本用法

CrewAI CLI 命令的基本结构是:

crewai [COMMAND] [OPTIONS] [ARGUMENTS]

可用命令

1. 创建

创建一个新的团队或流程。

crewai create [OPTIONS] TYPE NAME
  • TYPE: 在“crew”或“flow”之间选择
  • NAME: 团队或流程的名称

示例:

crewai create crew my_new_crew
crewai create flow my_new_flow

2. 版本

显示已安装的CrewAI版本。

crewai version [OPTIONS]
  • --tools: (可选)显示已安装的CrewAI工具版本

示例:

crewai version
crewai version --tools

3. 训练

为指定的迭代次数训练团队。

crewai train [OPTIONS]
  • -n, --n_iterations INTEGER: 训练团队的迭代次数(默认值:5)
  • -f, --filename TEXT: 用于训练的自定义文件的路径(默认:“trained_agents_data.pkl”)

示例:

crewai train -n 10 -f my_training_data.pkl

4. 重播

从特定任务重放机组执行。

crewai replay [OPTIONS]
  • -t, --task_id TEXT: 从该任务ID重放任务,包括所有后续任务

示例:

crewai replay -t task_123456

5. 日志任务输出

检索您最新的crew.kickoff()任务输出。

crewai log-tasks-outputs

6. 重置记忆

重置船员记忆(长期、短期、实体、最新的船员启动输出)。

crewai reset-memories [OPTIONS]
  • -l, --long: 重置长期记忆
  • -s, --short: 重置短期记忆
  • -e, --entities: 重置 ENTITIES 内存
  • -k, --kickoff-outputs: 重置最新的KICKOFF任务输出
  • -a, --all: 重置所有记忆

示例:

crewai reset-memories --long --short
crewai reset-memories --all

7. 测试

测试团队并评估结果。

crewai test [OPTIONS]
  • -n, --n_iterations INTEGER: 测试团队的迭代次数(默认值:3)
  • -m, --model TEXT: 用于在Crew上运行测试的LLM模型(默认:“gpt-4o-mini”)

示例:

crewai test -n 5 -m gpt-3.5-turbo

8. 运行

运行团队。

crewai run

确保从设置CrewAI项目的目录中运行这些命令。 某些命令可能需要在项目结构中进行额外的配置或设置。

9. API 密钥

当运行crewai create crew命令时,CLI 将首先显示前 5 个最常见的 LLM 提供商,并要求您选择一个。

一旦你选择了LLM提供商,系统将提示你输入API密钥。

初始API密钥提供者

CLI 最初会提示输入以下服务的 API 密钥:

  • OpenAI
  • Groq
  • Anthropic
  • Google Gemini
  • SambaNova

当你选择一个提供商时,CLI 会提示你输入你的 API 密钥。

其他选项

如果您选择选项6,您将能够从LiteLLM支持的提供商列表中进行选择。

当您选择一个提供商时,CLI 将提示您输入密钥名称和 API 密钥。

请参阅以下链接以获取每个提供者的键名:

这个页面有帮助吗?