mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-01 04:08:30 +00:00
f39a975e20
* updated CLI to allow for submitting API keys * updated click prompt to remove default number * removed all unnecessary comments * feat: implement crew creation CLI command - refactor code to multiple functions - Added ability for users to select provider and model when uing crewai create command and ave API key to .env * refactered select_choice function for early return * refactored select_provider to have an ealry return * cleanup of comments * refactor/Move functions into utils file, added new provider file and migrated fucntions thre, new constants file + general function refactor * small comment cleanup * fix unnecessary deps * Added docs for new CLI provider + fixed missing API prompt * Minor doc updates * allow user to bypass api key entry + incorect number selected logic + ruff formatting * ruff updates * Fix spelling mistake --------- Co-authored-by: Brandon Hancock (bhancock_ai) <109994880+bhancockio@users.noreply.github.com> Co-authored-by: Brandon Hancock <brandon@brandonhancock.io>
180 lines
3.5 KiB
Plaintext
180 lines
3.5 KiB
Plaintext
---
|
|
title: CLI
|
|
description: Learn how to use the CrewAI CLI to interact with CrewAI.
|
|
icon: terminal
|
|
---
|
|
|
|
# CrewAI CLI Documentation
|
|
|
|
The CrewAI CLI provides a set of commands to interact with CrewAI, allowing you to create, train, run, and manage crews & flows.
|
|
|
|
## Installation
|
|
|
|
To use the CrewAI CLI, make sure you have CrewAI installed:
|
|
|
|
```shell
|
|
pip install crewai
|
|
```
|
|
|
|
## Basic Usage
|
|
|
|
The basic structure of a CrewAI CLI command is:
|
|
|
|
```shell
|
|
crewai [COMMAND] [OPTIONS] [ARGUMENTS]
|
|
```
|
|
|
|
## Available Commands
|
|
|
|
### 1. Create
|
|
|
|
Create a new crew or pipeline.
|
|
|
|
```shell
|
|
crewai create [OPTIONS] TYPE NAME
|
|
```
|
|
|
|
- `TYPE`: Choose between "crew" or "pipeline"
|
|
- `NAME`: Name of the crew or pipeline
|
|
- `--router`: (Optional) Create a pipeline with router functionality
|
|
|
|
Example:
|
|
```shell
|
|
crewai create crew my_new_crew
|
|
crewai create pipeline my_new_pipeline --router
|
|
```
|
|
|
|
### 2. Version
|
|
|
|
Show the installed version of CrewAI.
|
|
|
|
```shell
|
|
crewai version [OPTIONS]
|
|
```
|
|
|
|
- `--tools`: (Optional) Show the installed version of CrewAI tools
|
|
|
|
Example:
|
|
```shell
|
|
crewai version
|
|
crewai version --tools
|
|
```
|
|
|
|
### 3. Train
|
|
|
|
Train the crew for a specified number of iterations.
|
|
|
|
```shell
|
|
crewai train [OPTIONS]
|
|
```
|
|
|
|
- `-n, --n_iterations INTEGER`: Number of iterations to train the crew (default: 5)
|
|
- `-f, --filename TEXT`: Path to a custom file for training (default: "trained_agents_data.pkl")
|
|
|
|
Example:
|
|
```shell
|
|
crewai train -n 10 -f my_training_data.pkl
|
|
```
|
|
|
|
### 4. Replay
|
|
|
|
Replay the crew execution from a specific task.
|
|
|
|
```shell
|
|
crewai replay [OPTIONS]
|
|
```
|
|
|
|
- `-t, --task_id TEXT`: Replay the crew from this task ID, including all subsequent tasks
|
|
|
|
Example:
|
|
```shell
|
|
crewai replay -t task_123456
|
|
```
|
|
|
|
### 5. Log-tasks-outputs
|
|
|
|
Retrieve your latest crew.kickoff() task outputs.
|
|
|
|
```shell
|
|
crewai log-tasks-outputs
|
|
```
|
|
|
|
### 6. Reset-memories
|
|
|
|
Reset the crew memories (long, short, entity, latest_crew_kickoff_outputs).
|
|
|
|
```shell
|
|
crewai reset-memories [OPTIONS]
|
|
```
|
|
|
|
- `-l, --long`: Reset LONG TERM memory
|
|
- `-s, --short`: Reset SHORT TERM memory
|
|
- `-e, --entities`: Reset ENTITIES memory
|
|
- `-k, --kickoff-outputs`: Reset LATEST KICKOFF TASK OUTPUTS
|
|
- `-a, --all`: Reset ALL memories
|
|
|
|
Example:
|
|
```shell
|
|
crewai reset-memories --long --short
|
|
crewai reset-memories --all
|
|
```
|
|
|
|
### 7. Test
|
|
|
|
Test the crew and evaluate the results.
|
|
|
|
```shell
|
|
crewai test [OPTIONS]
|
|
```
|
|
|
|
- `-n, --n_iterations INTEGER`: Number of iterations to test the crew (default: 3)
|
|
- `-m, --model TEXT`: LLM Model to run the tests on the Crew (default: "gpt-4o-mini")
|
|
|
|
Example:
|
|
```shell
|
|
crewai test -n 5 -m gpt-3.5-turbo
|
|
```
|
|
|
|
### 8. Run
|
|
|
|
Run the crew.
|
|
|
|
```shell
|
|
crewai run
|
|
```
|
|
<Note>
|
|
Make sure to run these commands from the directory where your CrewAI project is set up.
|
|
Some commands may require additional configuration or setup within your project structure.
|
|
</Note>
|
|
|
|
|
|
### 9. API Keys
|
|
|
|
When running ```crewai create crew``` command, the CLI will first show you the top 5 most common LLM providers and ask you to select one.
|
|
|
|
Once you've selected an LLM provider, you will be prompted for API keys.
|
|
|
|
#### Initial API key providers
|
|
|
|
The CLI will initially prompt for API keys for the following services:
|
|
|
|
* OpenAI
|
|
* Groq
|
|
* Anthropic
|
|
* Google Gemini
|
|
|
|
When you select a provider, the CLI will prompt you to enter your API key.
|
|
|
|
#### Other Options
|
|
|
|
If you select option 6, you will be able to select from a list of LiteLLM supported providers.
|
|
|
|
When you select a provider, the CLI will prompt you to enter the Key name and the API key.
|
|
|
|
See the following link for each provider's key name:
|
|
|
|
* [LiteLLM Providers](https://docs.litellm.ai/docs/providers)
|
|
|
|
|
|
|