命令行界面（CLI）

​

概述

​

安装

pip install crewai

​

基本用法

crewai [COMMAND] [OPTIONS] [ARGUMENTS]

​

可用命令

​

1. Create

crewai create [OPTIONS] TYPE NAME

• TYPE：在“crew”或“flow”之间选择
• NAME：crew 或 flow 的名称

crewai create crew my_new_crew
crewai create flow my_new_flow

​

2. Version

crewai version [OPTIONS]

• --tools：（可选）显示已安装的 CrewAI 工具版本

crewai version
crewai version --tools

​

3. Train

crewai train [OPTIONS]

• -n, --n_iterations INTEGER：训练 crew 的迭代次数（默认：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 重播 crew，包括所有后续任务

crewai replay -t task_123456

​

5. Log-tasks-outputs

crewai log-tasks-outputs

​

6. Reset-memories

crewai reset-memories [OPTIONS]

• -l, --long：重置长期记忆
• -s, --short：重置短期记忆
• -e, --entities：重置实体记忆
• -k, --kickoff-outputs：重置最近的 KICKOFF 任务输出
• -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：测试 crew 的迭代次数（默认：3）
• -m, --model TEXT：在 Crew 上运行测试的 LLM 模型（默认：“gpt-4o-mini”）

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

​

8. Run

crewai run

​

9. Chat

crewai chat

@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。您可以使用以下命令登录或创建账户
  终端

  复制

  询问 AI

  crewai login
  

• 创建部署：一旦您通过身份验证，就可以从本地项目的根目录为您的 crew 或 flow 创建部署。
  终端

  复制

  询问 AI

  crewai deploy create
  

  • 读取您的本地项目配置。
  • 提示您确认本地找到的环境变量（如 OPENAI_API_KEY, SERPER_API_KEY）。这些将安全地存储在企业平台上的部署中。在运行此命令之前，请确保您的敏感密钥已在本地正确配置（例如，在 .env 文件中）。

​

11. 组织管理

crewai org [COMMAND] [OPTIONS]

​

命令

• list：列出您所属的所有组织

crewai org list

• current：显示您当前活动的组织

crewai org current

• switch：切换到特定组织

crewai org switch <organization_id>

• 创建部署（续）
  • 将部署链接到相应的远程 GitHub 仓库（通常会自动检测）。
• 部署 Crew：一旦您通过身份验证，就可以将您的 crew 或 flow 部署到 CrewAI AMP。
  终端

  复制

  询问 AI

  crewai deploy push
  

  • 在 CrewAI AMP 平台上启动部署过程。
  • 成功启动后，它将输出 `Deployment created successfully!` 消息，以及部署名称和一个唯一的部署 ID (UUID)。
• 部署状态：您可以使用以下命令检查部署状态
  终端

  复制

  询问 AI

  crewai deploy status
  

  这将获取您最近一次部署尝试的最新部署状态（例如，Building Images for Crew, Deploy Enqueued, Online）。
• 部署日志：您可以使用以下命令检查部署日志
  终端

  复制

  询问 AI

  crewai deploy logs
  

  这将把部署日志流式传输到您的终端。
• 列出部署：您可以使用以下命令列出所有部署
  终端

  复制

  询问 AI

  crewai deploy list
  

  这将列出您的所有部署。
• 删除部署：您可以使用以下命令删除部署
  终端

  复制

  询问 AI

  crewai deploy remove
  

  这将从 CrewAI AMP 平台删除该部署。
• 帮助命令：您可以使用以下命令获取 CLI 的帮助信息
  终端

  复制

  询问 AI

  crewai deploy --help
  

  这将显示 CrewAI Deploy CLI 的帮助消息。

​

11. Login

crewai login

• 您的终端会显示一个验证 URL 和一个短代码
• 您的浏览器会打开该验证 URL
• 输入/确认代码以完成身份验证

• OAuth2 提供商和域通过 crewai config 配置（默认使用 login.crewai.com）
• 成功登录后，CLI 还会自动尝试向工具库进行身份验证
• 如果您重置了配置，请再次运行 crewai login 以重新进行身份验证

​

12. API 密钥

​

可用的 LLM 提供商

• OpenAI
• Groq
• Anthropic
• Google Gemini
• SambaNova

​

其他选项

• LiteLLM 提供商

​

13. 配置管理

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

crewai config set enterprise_base_url https://my-enterprise.crewai.com

crewai config set oauth2_provider auth0

crewai config set oauth2_domain my-company.auth0.com

crewai config reset