跳转到主要内容

文档索引

获取完整文档索引： https://docs.crewai.com.cn/llms.txt

在深入了解之前，请使用此文件来浏览所有可用页面。

从 0.140.0 版本开始，CrewAI AMP 开始迁移其登录提供商。因此，CLI 的身份验证流程已更新。使用 Google 登录或在 2025 年 7 月 3 日之后创建账户的用户将无法使用旧版本的 crewai 库登录。

​
概述

CrewAI CLI 提供了一套与 CrewAI 交互的命令，允许您创建、训练、运行和管理 Crew（团队）与 Flow（流程）。

​
安装

要使用 CrewAI CLI，请确保您已安装 CrewAI。
终端
pip install crewai

​
基本用法

CrewAI CLI 命令的基本结构为：
终端
crewai [COMMAND] [OPTIONS] [ARGUMENTS]

​
可用命令

​
1. Create（创建）

创建一个新的团队或流程。
终端
crewai create [OPTIONS] TYPE NAME
  • TYPE：在“crew”或“flow”之间选择
  • NAME：团队或流程的名称
示例
终端
crewai create crew my_new_crew
crewai create flow my_new_flow

​
2. Version（版本）

显示已安装的 CrewAI 版本。
终端
crewai version [OPTIONS]
  • --tools：（可选）显示已安装的 CrewAI 工具版本
示例
终端
crewai version
crewai version --tools

​
3. Train（训练）

训练团队指定的迭代次数。
终端
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. Replay（重放）

从特定任务开始重放团队执行。
终端
crewai replay [OPTIONS]
  • -t, --task_id TEXT：从该任务 ID 开始重放团队，包括所有后续任务
示例
终端
crewai replay -t task_123456

​
5. Log-tasks-outputs（日志任务输出）

获取您最近的 crew.kickoff() 任务输出。
终端
crewai log-tasks-outputs

​
6. Reset-memories（重置记忆）

重置团队记忆（长期、短期、实体、最近一次 kickoff 输出）。
终端
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. Test（测试）

测试团队并评估结果。
终端
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. Run（运行）

运行团队或流程。
终端
crewai run
从 0.103.0 版本开始，crewai run 命令可用于运行标准团队和流程。对于流程，它会自动从 pyproject.toml 检测类型并运行相应命令。这是目前运行团队和流程的推荐方式。
请确保在设置了 CrewAI 项目的目录中运行这些命令。某些命令可能需要在项目结构内进行额外的配置或设置。

​
9. Chat（对话）

从 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. Deploy（部署）

将团队或流程部署到 CrewAI AMP。
  • 身份验证：您需要经过身份验证才能部署到 CrewAI AMP。您可以登录或创建账户：
    终端
    crewai login
  • 创建部署：身份验证后，您可以从本地项目的根目录为您的团队或流程创建部署。
    终端
    crewai deploy create
    • 读取您的本地项目配置。
    • 提示您确认在本地发现的环境变量（如 OPENAI_API_KEY, SERPER_API_KEY）。这些变量将安全地存储在企业平台的部署中。在运行此操作前，请确保您的敏感密钥在本地（例如在 .env 文件中）配置正确。

​
11. 组织管理

管理您的 CrewAI AMP 组织。
终端
crewai org [COMMAND] [OPTIONS]

​
命令

  • list：列出您所属的所有组织
终端
crewai org list
  • current：显示您当前激活的组织
终端
crewai org current
  • switch：切换到特定组织
终端
crewai org switch <organization_id>
您必须先通过 CrewAI AMP 身份验证才能使用这些组织管理命令。
  • 创建部署（续）
    • 将部署链接到相应的远程 GitHub 仓库（通常会自动检测）。
  • 部署团队：身份验证后，您可以将团队或流程部署到 CrewAI AMP。
    终端
    crewai deploy push
    • 启动 CrewAI AMP 平台上的部署过程。
    • 成功启动后，它将输出“Deployment created successfully!”消息以及部署名称和唯一的部署 ID (UUID)。
  • 部署状态：您可以使用以下命令检查部署状态：
    终端
    crewai deploy status
    这会获取您最近一次尝试部署的最新状态（例如 Building Images for Crew, Deploy Enqueued, Online）。
  • 部署日志：您可以使用以下命令检查部署日志：
    终端
    crewai deploy logs
    这会将部署日志流式传输到您的终端。
  • 列出部署：您可以使用以下命令列出所有部署：
    终端
    crewai deploy list
    这会列出您所有的部署。
  • 删除部署：您可以使用以下命令删除部署：
    终端
    crewai deploy remove
    这会从 CrewAI AMP 平台删除该部署。
  • 帮助命令：您可以获取 CLI 的帮助：
    终端
    crewai deploy --help
    这会显示 CrewAI Deploy CLI 的帮助信息。
观看此视频教程，获取使用 CLI 将您的团队部署到 CrewAI AMP 的分步演示。

​
11. Login（登录）

使用安全设备代码流程通过 CrewAI AMP 进行身份验证（无需输入电子邮件）。
终端
crewai login
流程如下：
  • 终端中会显示一个验证 URL 和短代码
  • 浏览器自动打开验证 URL
  • 输入/确认代码以完成身份验证
注意
  • OAuth2 提供商和域名通过 crewai config 配置（默认为 login.crewai.com）
  • 登录成功后，CLI 也会尝试自动验证工具仓库（Tool Repository）的权限
  • 如果您重置了配置，请再次运行 crewai login 进行重新验证

​
12. API 密钥

当运行 crewai create crew 命令时，CLI 将向您展示可用的 LLM 提供商列表，随后为您选择的提供商进行模型选择。 选择完 LLM 提供商和模型后，系统将提示您输入 API 密钥。

​
可用 LLM 提供商

以下是 CLI 建议的最受欢迎的 LLM 提供商列表
  • OpenAI
  • Groq
  • Anthropic
  • Google Gemini
  • SambaNova
当您选择提供商时，CLI 将向您显示该提供商的可用模型并提示您输入 API 密钥。

​
其他选项

如果您选择“other”，您将能够从 LiteLLM 支持的提供商列表中进行选择。 选择提供商后，CLI 将提示您输入密钥名称和 API 密钥。 有关每个提供商的密钥名称，请参阅以下链接：

​
13. 配置管理

管理 CrewAI 的 CLI 配置设置。
终端
crewai config [COMMAND] [OPTIONS]

​
命令

  • list：显示所有 CLI 配置参数
终端
crewai config list
  • set：设置 CLI 配置参数
终端
crewai config set <key> <value>
  • reset：将所有 CLI 配置参数重置为默认值
终端
crewai config reset

​
可用配置参数

  • enterprise_base_url：CrewAI AMP 实例的基础 URL
  • oauth2_provider：用于身份验证的 OAuth2 提供商（例如，workos, okta, auth0）
  • oauth2_audience：OAuth2 受众值，通常用于标识目标 API 或资源
  • oauth2_client_id：提供商颁发的 OAuth2 客户端 ID，用于身份验证请求
  • oauth2_domain：OAuth2 提供商的域名（例如，your-org.auth0.com），用于颁发令牌

​
示例

显示当前配置
终端
crewai config list
示例输出
设置值描述
enterprise_base_urlhttps://app.crewai.comCrewAI AMP 实例的基础 URL
org_name未设置当前激活的组织名称
org_uuid未设置当前激活的组织 UUID
oauth2_providerworkosOAuth2 提供商（例如，workos, okta, auth0）
oauth2_audienceclient_01YYY标识目标 API/资源的受众
oauth2_client_idclient_01XXX提供商颁发的 OAuth2 客户端 ID
oauth2_domainlogin.crewai.com提供商域名（例如，your-org.auth0.com）
设置企业基础 URL
终端
crewai config set enterprise_base_url https://my-enterprise.crewai.com
设置 OAuth2 提供商
终端
crewai config set oauth2_provider auth0
设置 OAuth2 域名
终端
crewai config set oauth2_domain my-company.auth0.com
重置所有配置为默认值
终端
crewai config reset
重置配置后，请重新运行 crewai login 进行身份验证。

​
14. 追踪管理

管理团队和流程执行的追踪收集首选项。
终端
crewai traces [COMMAND]

​
命令

  • enable：启用团队/流程执行的追踪收集
终端
crewai traces enable
  • disable：禁用团队/流程执行的追踪收集
终端
crewai traces disable
  • status：显示当前追踪收集状态
终端
crewai traces status

​
追踪的工作原理

追踪收集通过按优先级检查三个设置来控制：
  1. 代码中的显式标志（最高优先级 - 可启用或禁用） 
    crew = Crew(agents=[...], tasks=[...], tracing=True)   # Always enable
crew = Crew(agents=[...], tasks=[...], tracing=False)  # Always disable
crew = Crew(agents=[...], tasks=[...])                 # Check lower priorities (default)
    • tracing=True 将始终启用追踪（覆盖所有其他设置）
    • tracing=False 将始终禁用追踪（覆盖所有其他设置）
    • tracing=None 或省略该参数将检查较低优先级的设置
  2. 环境变量（第二优先级） 
    CREWAI_TRACING_ENABLED=true
    • 仅当代码中未明确设置 tracing 为 True 或 False 时进行检查
    • 设置为 true 或 1 以启用追踪
  3. 用户偏好（最低优先级）
    终端
    crewai traces enable
    • 仅当代码中未设置追踪且 CREWAI_TRACING_ENABLED 未设置为 true 时进行检查
    • 运行 crewai traces enable 本身就足以启用追踪
要启用追踪，请使用以下任一方法：
  • 在您的团队/流程代码中设置 tracing=True，或者
  • 将 CREWAI_TRACING_ENABLED=true 添加到您的 .env 文件中，或者
  • 运行 crewai traces enable
要禁用追踪，请使用以下任一方法：
  • 在您的团队/流程代码中设置 tracing=False（覆盖所有内容），或者
  • 移除或设置 CREWAI_TRACING_ENABLED 环境变量为 false，或者
  • 运行 crewai traces disable
高优先级设置会覆盖低优先级设置。
有关追踪的更多信息，请参阅追踪文档。
CrewAI CLI 在向您的项目添加包时，会自动处理工具仓库的身份验证。只需在任何 uv 命令前加上 crewai 即可使用。例如：crewai uv add requests。有关详细信息，请参阅工具仓库文档。
配置设置存储在 ~/.config/crewai/settings.json 中。一些设置（如组织名称和 UUID）是只读的，通过身份验证和组织管理命令进行管理。与工具仓库相关的设置是隐藏的，用户无法直接设置。