​
CrewAI CLI 文档

CrewAI CLI 提供了一系列命令，用于与 CrewAI 进行交互，您可以使用它来创建、训练、运行和管理船员及流程。

​
安装

要使用 CrewAI CLI，请确保您已安装 CrewAI

终端
pip install crewai

​
基本用法

CrewAI CLI 命令的基本结构是

终端
crewai [COMMAND] [OPTIONS] [ARGUMENTS]

​
可用命令

​
1. 创建

创建一个新的船员或流程。

终端
crewai create [OPTIONS] TYPE NAME
  • TYPE：选择“船员”或“流程”
  • 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：重置实体记忆
  • -k, --kickoff-outputs：重置最近的启动任务输出
  • -kn, --knowledge：重置知识存储
  • -akn, --agent-knowledge：重置代理知识存储
  • -a, --all：重置所有记忆

示例

终端
crewai reset-memories --long --short
crewai reset-memories --all

​
7. 测试

测试船员并评估结果。

终端
crewai test [OPTIONS]
  • -n, --n_iterations INTEGER：测试船员的迭代次数（默认值：3）
  • -m, --model TEXT：用于在船员上运行测试的 LLM 模型（默认值：“gpt-4o-mini”）

示例

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

​
8. 运行

运行船员或流程。

终端
crewai run

从版本 0.103.0 开始，crewai run 命令可用于运行标准船员和流程。对于流程，它会自动从 pyproject.toml 检测类型并运行相应的命令。这是目前推荐的运行船员和流程的方式。

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

​
9. 聊天

从版本 0.98.0 开始，当您运行 crewai chat 命令时，您将与您的船员启动一个交互式会话。AI 助手将通过询问执行船员所需的输入来引导您。提供所有输入后，船员将执行其任务。

收到结果后，您可以继续与助手互动，以获取进一步的指示或提出问题。

终端
crewai chat

请确保您从 CrewAI 项目的根目录执行这些命令。

重要提示：在您的 crew.py 文件中设置 chat_llm 属性以启用此命令。

@crew
def crew(self) -> Crew:
    return Crew(
        agents=self.agents,
        tasks=self.tasks,
        process=Process.sequential,
        verbose=True,
        chat_llm="gpt-4o",  # LLM for chat orchestration
    )

​
10. 部署

将船员或流程部署到 CrewAI Enterprise。

  • 身份验证：您需要通过身份验证才能部署到 CrewAI Enterprise。

    终端
    crewai signup

    如果您已有帐户，可以使用以下命令登录

    终端
    crewai login

  • 创建部署：通过身份验证后，您可以从本地项目的根目录为您船员或流程创建部署。

    终端
    crewai deploy create
    • 读取您的本地项目配置。
    • 提示您确认在本地找到的环境变量（例如 OPENAI_API_KEY, SERPER_API_KEY）。这些变量将与部署一起安全地存储在企业平台。在运行此命令之前，请确保您的敏感密钥已在本地正确配置（例如，在 .env 文件中）。
    • 将部署链接到相应的远程 GitHub 仓库（通常会自动检测）。

  • 部署船员：通过身份验证后，您可以将您的船员或流程部署到 CrewAI Enterprise。

    终端
    crewai deploy push
    • 在 CrewAI Enterprise 平台上启动部署过程。
    • 成功启动后，它将输出“部署创建成功！”消息，以及部署名称和唯一的部署 ID（UUID）。

  • 部署状态：您可以使用以下命令检查部署状态

    终端
    crewai deploy status

    此命令获取您最近一次部署尝试的最新部署状态（例如，“正在构建船员镜像”、“部署已排队”、“在线”）。

  • 部署日志：您可以使用以下命令检查部署日志

    终端
    crewai deploy logs

    此命令将部署日志流式传输到您的终端。

  • 列出部署：您可以使用以下命令列出所有部署

    终端
    crewai deploy list

    此命令列出您的所有部署。

  • 删除部署：您可以使用以下命令删除部署

    终端
    crewai deploy remove

    此命令将从 CrewAI Enterprise 平台删除部署。

  • 帮助命令：您可以使用以下命令获取 CLI 帮助

    终端
    crewai deploy --help

    此命令显示 CrewAI Deploy CLI 的帮助信息。

观看此视频教程，了解如何使用 CLI 将您的船员部署到 CrewAI Enterprise 的分步演示。

​
11. API 密钥

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

选择 LLM 提供商后，系统将提示您输入 API 密钥。

​
初始 API 密钥提供商

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

  • OpenAI
  • Groq
  • Anthropic
  • Google Gemini
  • SambaNova

选择提供商后，CLI 将提示您输入 API 密钥。

​
其他选项

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

选择提供商后，CLI 将提示您输入密钥名称和 API 密钥。

请参阅以下链接了解每个提供商的密钥名称