Since release 0.140.0, CrewAI Enterprise 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
Basic Usage
The basic structure of a CrewAI CLI command is:Terminal
Available Commands
1. Create
Create a new crew or flow.Terminal
TYPE
: Choose between “crew” or “flow”NAME
: Name of the crew or flow
Terminal
2. Version
Show the installed version of CrewAI.Terminal
--tools
: (Optional) Show the installed version of CrewAI tools
Terminal
3. Train
Train the crew for a specified number of iterations.Terminal
-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”)
Terminal
4. Replay
Replay the crew execution from a specific task.Terminal
-t, --task_id TEXT
: Replay the crew from this task ID, including all subsequent tasks
Terminal
5. Log-tasks-outputs
Retrieve your latest crew.kickoff() task outputs.Terminal
6. Reset-memories
Reset the crew memories (long, short, entity, latest_crew_kickoff_outputs).Terminal
-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
Terminal
7. Test
Test the crew and evaluate the results.Terminal
-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”)
Terminal
8. Run
Run the crew or flow.Terminal
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 version0.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
Ensure you execute these commands from your CrewAI project’s root directory.
IMPORTANT: Set the
chat_llm
property in your crew.py
file to enable this command.10. Deploy
Deploy the crew or flow to CrewAI Enterprise.-
Authentication: You need to be authenticated to deploy to CrewAI Enterprise.
You can login or create an account with:
Terminal
-
Create a deployment: Once you are authenticated, you can create a deployment for your crew or flow from the root of your localproject.
Terminal
- 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 Enterprise organizations.Terminal
Commands:
list
: List all organizations you belong to
Terminal
current
: Display your currently active organization
Terminal
switch
: Switch to a specific organization
Terminal
You must be authenticated to CrewAI Enterprise 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 Enterprise.
Terminal
- Initiates the deployment process on the CrewAI Enterprise 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:
This fetches the latest deployment status of your most recent deployment attempt (e.g.,Terminal
Building Images for Crew
,Deploy Enqueued
,Online
). -
Deployment Logs: You can check the logs of your deployment with:
This streams the deployment logs to your terminal.Terminal
-
List deployments: You can list all your deployments with:
This lists all your deployments.Terminal
-
Delete a deployment: You can delete a deployment with:
This deletes the deployment from the CrewAI Enterprise platform.Terminal
-
Help Command: You can get help with the CLI with:
This shows the help message for the CrewAI Deploy CLI.Terminal
11. Login
Authenticate with CrewAI Enterprise using a secure device code flow (no email entry required).Terminal
- 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
- The OAuth2 provider and domain are configured via
crewai config
(defaults uselogin.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 runningcrewai create crew
command, the CLI will show you a list of available LLM providers to choose from, followed by model selection for your chosen provider.
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
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:13. Configuration Management
Manage CLI configuration settings for CrewAI.Terminal
Commands:
list
: Display all CLI configuration parameters
Terminal
set
: Set a CLI configuration parameter
Terminal
reset
: Reset all CLI configuration parameters to default values
Terminal
Available Configuration Parameters
enterprise_base_url
: Base URL of the CrewAI Enterprise instanceoauth2_provider
: OAuth2 provider used for authentication (e.g., workos, okta, auth0)oauth2_audience
: OAuth2 audience value, typically used to identify the target API or resourceoauth2_client_id
: OAuth2 client ID issued by the provider, used during authentication requestsoauth2_domain
: OAuth2 provider’s domain (e.g., your-org.auth0.com) used for issuing tokens
Examples
Display current configuration:Terminal
Setting | Value | Description |
---|---|---|
enterprise_base_url | https://app.crewai.com | Base URL of the CrewAI Enterprise 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) |
Terminal
Terminal
Terminal
Terminal
After resetting configuration, re-run
crewai login
to authenticate again.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.