CLI - CrewAI

Since release 0.140.0, CrewAI AMP started a process of migrating their login provider. As such, the authentication flow via CLI was updated. Users that use Google to login, or that created their account after July 3rd, 2025 will be unable to log in with older versions of the crewai library.

Overview

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:

Terminal

pip install crewai

Basic Usage

The basic structure of a CrewAI CLI command is:

Terminal

crewai [COMMAND] [OPTIONS] [ARGUMENTS]

Available Commands

1. Create

Create a new crew or flow.

Terminal

crewai create [OPTIONS] TYPE NAME

TYPE: Choose between “crew” or “flow”
NAME: Name of the crew or flow

Example:

Terminal

crewai create crew my_new_crew
crewai create flow my_new_flow

By default, crewai create crew creates a JSON-first crew project with crew.jsonc and agents/*.jsonc. Use crewai create crew my_new_crew --classic only when you want the older Python/YAML scaffold with crew.py, config/agents.yaml, and config/tasks.yaml.

2. Version

Show the installed version of CrewAI.

Terminal

crewai version [OPTIONS]

--tools: (Optional) Show the installed version of CrewAI tools

Example:

Terminal

crewai version
crewai version --tools

3. Train

Train the crew for a specified number of iterations.

Terminal

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:

Terminal

crewai train -n 10 -f my_training_data.pkl

4. Replay

Replay the crew execution from a specific task.

Terminal

crewai replay [OPTIONS]

-t, --task_id TEXT: Replay the crew from this task ID, including all subsequent tasks

Example:

Terminal

crewai replay -t task_123456

5. Log-tasks-outputs

Retrieve your latest crew.kickoff() task outputs.

Terminal

crewai log-tasks-outputs

6. Reset-memories

Reset the crew memories (long, short, entity, latest_crew_kickoff_outputs).

Terminal

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
-kn, --knowledge: Reset KNOWLEDGE storage
-akn, --agent-knowledge: Reset AGENT KNOWLEDGE storage
-a, --all: Reset ALL memories

Example:

Terminal

crewai reset-memories --long --short
crewai reset-memories --all

7. Test

Test the crew and evaluate the results.

Terminal

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:

Terminal

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

8. Run

Run the crew or flow.

Terminal

crewai run

Starting from version 0.103.0, the crewai run command can be used to run both standard crews and flows. For flows, it automatically detects the type from pyproject.toml and runs the appropriate command. This is now the recommended way to run both crews and flows.

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.

9. Chat

Starting in version 0.98.0, when you run the crewai chat command, you start an interactive session with your crew. The AI assistant will guide you by asking for necessary inputs to execute the crew. Once all inputs are provided, the crew will execute its tasks. After receiving the results, you can continue interacting with the assistant for further instructions or questions.

Terminal

crewai chat

Ensure you execute these commands from your CrewAI project’s root directory.

IMPORTANT: Set the chat_llm property in your crew definition to enable this command.For JSON-first crews, add it to crew.jsonc:

{
  "name": "My Crew",
  "agents": ["researcher"],
  "tasks": [],
  "chat_llm": "openai/gpt-4o"
}

For classic Python/YAML crews, set it in crew.py:

@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

Deploy the crew or flow to CrewAI AMP.

Authentication: You need to be authenticated to deploy to CrewAI AMP. You can login or create an account with:
Terminal
crewai login
Create a deployment: Once you are authenticated, you can create a deployment for your crew or flow from the root of your localproject.
Terminal
crewai deploy create
- Reads your local project configuration.
- Prompts you to confirm the environment variables (like OPENAI_API_KEY, SERPER_API_KEY) found locally. These will be securely stored with the deployment on the Enterprise platform. Ensure your sensitive keys are correctly configured locally (e.g., in a .env file) before running this.

11. Organization Management

Manage your CrewAI AMP organizations.

Terminal

crewai org [COMMAND] [OPTIONS]

Commands:

list: List all organizations you belong to

Terminal

crewai org list

current: Display your currently active organization

Terminal

crewai org current

switch: Switch to a specific organization

Terminal

crewai org switch <organization_id>

You must be authenticated to CrewAI AMP to use these organization management commands.

Create a deployment (continued):
- Links the deployment to the corresponding remote GitHub repository (it usually detects this automatically).
Deploy the Crew: Once you are authenticated, you can deploy your crew or flow to CrewAI AMP.
Terminal
crewai deploy push
- Initiates the deployment process on the CrewAI AMP platform.
- Upon successful initiation, it will output the Deployment created successfully! message along with the Deployment Name and a unique Deployment ID (UUID).
Deployment Status: You can check the status of your deployment with:
Terminal
crewai deploy status
This fetches the latest deployment status of your most recent deployment attempt (e.g., Building Images for Crew, Deploy Enqueued, Online).
Deployment Logs: You can check the logs of your deployment with:
Terminal
crewai deploy logs
This streams the deployment logs to your terminal.
List deployments: You can list all your deployments with:
Terminal
crewai deploy list
This lists all your deployments.
Delete a deployment: You can delete a deployment with:
Terminal
crewai deploy remove
This deletes the deployment from the CrewAI AMP platform.
Help Command: You can get help with the CLI with:
Terminal
crewai deploy --help
This shows the help message for the CrewAI Deploy CLI.

Watch this video tutorial for a step-by-step demonstration of deploying your crew to CrewAI AMP using the CLI.

Authenticate with CrewAI AMP using a secure device code flow (no email entry required).

Terminal

crewai login

What happens:

A verification URL and short code are displayed in your terminal
Your browser opens to the verification URL
Enter/confirm the code to complete authentication

Notes:

The OAuth2 provider and domain are configured via crewai config (defaults use login.crewai.com)
After successful login, the CLI also attempts to authenticate to the Tool Repository automatically
If you reset your configuration, run crewai login again to re-authenticate

12. API Keys

When running the crewai create crew command, the CLI shows a list of available LLM providers, followed by model selection for your chosen provider. The selected model is saved in the generated .env file and each generated agent JSONC file can set its own llm. Once you’ve selected an LLM provider and model, you will be prompted for API keys.

Available LLM Providers

Here’s a list of the most popular LLM providers suggested by the CLI:

OpenAI
Groq
Anthropic
Google Gemini
SambaNova

When you select a provider, the CLI will then show you available models for that provider and prompt you to enter your API key.

Other Options

If you select “other”, 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

13. Configuration Management

Manage CLI configuration settings for CrewAI.

Terminal

crewai config [COMMAND] [OPTIONS]

Commands:

list: Display all CLI configuration parameters

Terminal

crewai config list

set: Set a CLI configuration parameter

Terminal

crewai config set <key> <value>

reset: Reset all CLI configuration parameters to default values

Terminal

crewai config reset

Available Configuration Parameters

enterprise_base_url: Base URL of the CrewAI AMP instance
oauth2_provider: OAuth2 provider used for authentication (e.g., workos, okta, auth0)
oauth2_audience: OAuth2 audience value, typically used to identify the target API or resource
oauth2_client_id: OAuth2 client ID issued by the provider, used during authentication requests
oauth2_domain: OAuth2 provider’s domain (e.g., your-org.auth0.com) used for issuing tokens

Examples

Display current configuration:

Terminal

crewai config list

Example output:

Setting	Value	Description
enterprise_base_url	https://app.crewai.com	Base URL of the CrewAI AMP instance
org_name	Not set	Name of the currently active organization
org_uuid	Not set	UUID of the currently active organization
oauth2_provider	workos	OAuth2 provider (e.g., workos, okta, auth0)
oauth2_audience	client_01YYY	Audience identifying the target API/resource
oauth2_client_id	client_01XXX	OAuth2 client ID issued by the provider
oauth2_domain	login.crewai.com	Provider domain (e.g., your-org.auth0.com)

Set the enterprise base URL:

Terminal

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

Set OAuth2 provider:

Terminal

crewai config set oauth2_provider auth0

Set OAuth2 domain:

Terminal

crewai config set oauth2_domain my-company.auth0.com

Reset all configuration to defaults:

Terminal

crewai config reset

After resetting configuration, re-run crewai login to authenticate again.

14. Trace Management

Manage trace collection preferences for your Crew and Flow executions.

Terminal

crewai traces [COMMAND]

Commands:

enable: Enable trace collection for crew/flow executions

Terminal

crewai traces enable

disable: Disable trace collection for crew/flow executions

Terminal

crewai traces disable

status: Show current trace collection status

Terminal

crewai traces status

How Tracing Works

Trace collection is controlled by checking three settings in priority order:

Explicit flag in code (highest priority - can enable OR disable):

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 will always enable tracing (overrides everything)
tracing=False will always disable tracing (overrides everything)
tracing=None or omitted will check lower priority settings

Environment variable (second priority):
CREWAI_TRACING_ENABLED=true
- Checked only if tracing is not explicitly set to True or False in code
- Set to true or 1 to enable tracing
User preference (lowest priority):
Terminal
crewai traces enable
- Checked only if tracing is not set in code and CREWAI_TRACING_ENABLED is not set to true
- Running crewai traces enable is sufficient to enable tracing by itself

To enable tracing, use any one of these methods:

Set tracing=True in your Crew/Flow code, OR
Add CREWAI_TRACING_ENABLED=true to your .env file, OR
Run crewai traces enable

To disable tracing, use any ONE of these methods:

Set tracing=False in your Crew/Flow code (overrides everything), OR
Remove or set to false the CREWAI_TRACING_ENABLED env var, OR
Run crewai traces disable

Higher priority settings override lower ones.

For more information about tracing, see the Tracing documentation.

CrewAI CLI handles authentication to the Tool Repository automatically when adding packages to your project. Just append crewai before any uv command to use it. E.g. crewai uv add requests. For more information, see Tool Repository docs.

Configuration settings are stored in ~/.config/crewai/settings.json. Some settings like organization name and UUID are read-only and managed through authentication and organization commands. Tool repository related settings are hidden and cannot be set directly by users.

​Overview

​Installation

​Basic Usage

​Available Commands

​1. Create

​2. Version

​3. Train

​4. Replay

​5. Log-tasks-outputs

​6. Reset-memories

​7. Test

​8. Run

​9. Chat

​10. Deploy

​11. Organization Management

​Commands:

​11. Login

​12. API Keys

​Available LLM Providers

​Other Options

​13. Configuration Management

​Commands:

​Available Configuration Parameters

​Examples

​14. Trace Management

​Commands:

​How Tracing Works

Overview

Installation

Basic Usage

Available Commands

1. Create

2. Version

3. Train

4. Replay

5. Log-tasks-outputs

6. Reset-memories

7. Test

8. Run

9. Chat

10. Deploy

11. Organization Management

Commands:

11. Login

12. API Keys

Available LLM Providers

Other Options

13. Configuration Management

Commands:

Available Configuration Parameters

Examples

14. Trace Management

Commands:

How Tracing Works