CLI

学习如何使用 CrewAI CLI 与 CrewAI 进行交互。

自 0.140.0 版本发布以来，CrewAI AMP 开始迁移其登录提供商。因此，CLI 的认证流程也已更新。使用 Google 登录的用户，或在 2025 年 7 月 3 日之后创建账户的用户，将无法使用旧版本 crewai 库完成登录。

概览

CrewAI CLI 提供了一组用于与 CrewAI 交互的命令，可用于创建、训练、运行以及管理 crews 和 flows。

安装

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

  1. pip install crewai

基本用法

CrewAI CLI 命令的基本结构如下：

  1. crewai [COMMAND] [OPTIONS] [ARGUMENTS]

可用命令

1. Create

创建一个新的 crew 或 flow。

  1. crewai create [OPTIONS] TYPE NAME
  • TYPE：可选 "crew" 或 "flow"
  • NAME：crew 或 flow 的名称

示例：

  1. crewai create crew my_new_crew
  2. crewai create flow my_new_flow

2. Version

显示已安装的 CrewAI 版本。

  1. crewai version [OPTIONS]
  • --tools：（可选）显示已安装的 CrewAI tools 版本

示例：

  1. crewai version
  2. crewai version --tools

3. Train

按指定迭代次数训练 crew。

  1. crewai train [OPTIONS]
  • -n, --n_iterations INTEGER：训练迭代次数（默认：5）
  • -f, --filename TEXT：自定义训练文件路径（默认："trained_agents_data.pkl"）

示例：

  1. crewai train -n 10 -f my_training_data.pkl

4. Replay

从某个指定 task 开始重新执行 crew。

  1. crewai replay [OPTIONS]
  • -t, --task_id TEXT：从该 task ID 开始回放，并包含其后的所有任务

示例：

  1. crewai replay -t task_123456

5. Log-tasks-outputs

获取你最近一次 crew.kickoff() 的任务输出。

  1. crewai log-tasks-outputs

6. Reset-memories

重置 crew 的 memories（long、short、entity、latest_crew_kickoff_outputs）。

  1. crewai reset-memories [OPTIONS]
  • -l, --long：重置 LONG TERM memory
  • -s, --short：重置 SHORT TERM memory
  • -e, --entities：重置 ENTITIES memory
  • -k, --kickoff-outputs：重置 LATEST KICKOFF TASK OUTPUTS
  • -kn, --knowledge：重置 KNOWLEDGE storage
  • -akn, --agent-knowledge：重置 AGENT KNOWLEDGE storage
  • -a, --all：重置所有 memories

示例：

  1. crewai reset-memories --long --short
  2. crewai reset-memories --all

7. Test

测试 crew 并评估结果。

  1. crewai test [OPTIONS]
  • -n, --n_iterations INTEGER：测试迭代次数（默认：3）
  • -m, --model TEXT：用于运行测试的 Crew LLM 模型（默认："gpt-4o-mini"）

示例：

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

8. Run

运行 crew 或 flow。

  1. crewai run
从 0.103.0 版本开始，crewai run 命令可同时用于运行标准 crew 和 flow。对于 flow，它会自动从 pyproject.toml 检测类型，并运行相应命令。这已成为运行 crew 和 flow 的推荐方式。 请确保你在 CrewAI 项目所在目录中运行这些命令。某些命令可能要求你在项目结构中完成额外配置或初始化。

9. Chat

从 0.98.0 版本开始，当你运行 crewai chat 命令时，会启动一个与你的 crew 的交互式会话。AI 助手会通过提问来引导你提供执行 crew 所需的输入。当所有输入都提供完成后，crew 就会执行任务。

在收到结果后，你还可以继续与助手交互，给出进一步指令或提出问题。

  1. crewai chat
请确保你在 CrewAI 项目的根目录中执行这些命令。 重要：需要在你的 crew.py 文件中设置 chat_llm 属性，才能启用该命令。 python @crew def crew(self) -> Crew: return Crew( agents=self.agents, tasks=self.tasks, process=Process.sequential, verbose=True, chat_llm="gpt-4o", # 用于 chat 编排的 LLM )

10. Deploy

将 crew 或 flow 部署到 CrewAI AMP。

  • 认证：你需要先完成认证，才能部署到 CrewAI AMP。 你可以通过以下命令登录或创建账户：

    1. crewai login

  • 创建部署：认证成功后，你可以在本地项目根目录中为 crew 或 flow 创建部署。

    1. crewai deploy create
    • 读取本地项目配置。
    • 提示你确认在本地检测到的环境变量（例如 OPENAI_API_KEY、SERPER_API_KEY）。这些变量会被安全地保存在 Enterprise 平台上的部署配置中。在运行该命令前，请确保你的敏感密钥已在本地正确配置（例如写入 .env 文件）。

11. Organization Management

管理你的 CrewAI AMP organizations。

  1. crewai org [COMMAND] [OPTIONS]

可用子命令

  • list：列出你所属的所有 organizations
  1. crewai org list
  • current：显示当前激活的 organization
  1. crewai org current
  • switch：切换到指定 organization
  1. crewai org switch <organization_id>
你必须先通过 CrewAI AMP 认证，才能使用这些 organization 管理命令。

  • 创建部署（续）：

    • 将部署关联到对应的远程 GitHub 仓库（通常会自动检测）。

  • 部署 Crew：认证成功后，你可以将 crew 或 flow 部署到 CrewAI AMP。

    1. crewai deploy push
    • 在 CrewAI AMP 平台上启动部署流程。
    • 成功启动后，会输出 Deployment created successfully! 消息，以及 Deployment Name 和唯一的 Deployment ID（UUID）。

  • 部署状态：你可以通过以下命令查看最近一次部署的状态：

    1. crewai deploy status

    它会获取最近一次部署尝试的最新状态（例如 Building Images for Crew、Deploy Enqueued、Online）。

  • 部署日志：你可以通过以下命令查看部署日志：

    1. crewai deploy logs

    它会将部署日志流式输出到终端。

  • 列出部署：你可以通过以下命令列出所有部署：

    1. crewai deploy list

    该命令会列出所有你的部署。

  • 删除部署：你可以通过以下命令删除某个部署：

    1. crewai deploy remove

    该命令会从 CrewAI AMP 平台删除该部署。

  • 帮助命令：你可以通过以下命令查看 CLI 帮助：

    1. crewai deploy --help

    它会显示 CrewAI Deploy CLI 的帮助信息。

观看这个视频教程，了解如何使用 CLI 将你的 crew 部署到 CrewAI AMP：