mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-03 21:28:29 +00:00
Some checks failed
Notify Downstream / notify-downstream (push) Has been cancelled
Co-authored-by: Lorenze Jay <63378463+lorenzejay@users.noreply.github.com>
238 lines
6.9 KiB
Plaintext
238 lines
6.9 KiB
Plaintext
---
|
|
title: "Deploy Crew"
|
|
description: "Deploy your local CrewAI project to the Enterprise platform"
|
|
icon: "cloud-arrow-up"
|
|
---
|
|
|
|
## Overview
|
|
|
|
This guide will walk you through the process of deploying your locally developed CrewAI project to the CrewAI Enterprise platform,
|
|
transforming it into a production-ready API endpoint.
|
|
|
|
## Option 1: CLI Deployment
|
|
|
|
<iframe
|
|
width="100%"
|
|
height="400"
|
|
src="https://www.youtube.com/embed/3EqSV-CYDZA"
|
|
title="Deploying a Crew to CrewAI Enterprise"
|
|
frameborder="0"
|
|
style={{ borderRadius: '10px' }}
|
|
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
|
allowfullscreen
|
|
></iframe>
|
|
|
|
### Prerequisites
|
|
|
|
Before starting the deployment process, make sure you have:
|
|
|
|
- A CrewAI project built locally ([follow our quickstart guide](/quickstart) if you haven't created one yet)
|
|
- Your code pushed to a GitHub repository
|
|
- The latest version of the CrewAI CLI installed (`uv tool install crewai`)
|
|
|
|
<Note>
|
|
For a quick reference project, you can clone our example repository at [github.com/tonykipkemboi/crewai-latest-ai-development](https://github.com/tonykipkemboi/crewai-latest-ai-development).
|
|
</Note>
|
|
|
|
|
|
<Steps>
|
|
|
|
<Step title="Authenticate with the Enterprise Platform">
|
|
First, you need to authenticate your CLI with the CrewAI Enterprise platform:
|
|
|
|
```bash
|
|
# If you already have a CrewAI Enterprise account
|
|
crewai login
|
|
|
|
# If you're creating a new account
|
|
crewai signup
|
|
```
|
|
|
|
When you run either command, the CLI will:
|
|
1. Display a URL and a unique device code
|
|
2. Open your browser to the authentication page
|
|
3. Prompt you to confirm the device
|
|
4. Complete the authentication process
|
|
|
|
Upon successful authentication, you'll see a confirmation message in your terminal!
|
|
|
|
</Step>
|
|
|
|
<Step title="Create a Deployment">
|
|
|
|
From your project directory, run:
|
|
|
|
```bash
|
|
crewai deploy create
|
|
```
|
|
|
|
This command will:
|
|
1. Detect your GitHub repository information
|
|
2. Identify environment variables in your local `.env` file
|
|
3. Securely transfer these variables to the Enterprise platform
|
|
4. Create a new deployment with a unique identifier
|
|
|
|
On successful creation, you'll see a message like:
|
|
```shell
|
|
Deployment created successfully!
|
|
Name: your_project_name
|
|
Deployment ID: 01234567-89ab-cdef-0123-456789abcdef
|
|
Current Status: Deploy Enqueued
|
|
```
|
|
|
|
</Step>
|
|
|
|
<Step title="Monitor Deployment Progress">
|
|
|
|
Track the deployment status with:
|
|
|
|
```bash
|
|
crewai deploy status
|
|
```
|
|
|
|
For detailed logs of the build process:
|
|
|
|
```bash
|
|
crewai deploy logs
|
|
```
|
|
|
|
<Tip>
|
|
The first deployment typically takes 10-15 minutes as it builds the container images. Subsequent deployments are much faster.
|
|
</Tip>
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Additional CLI Commands
|
|
|
|
The CrewAI CLI offers several commands to manage your deployments:
|
|
|
|
```bash
|
|
# List all your deployments
|
|
crewai deploy list
|
|
|
|
# Get the status of your deployment
|
|
crewai deploy status
|
|
|
|
# View the logs of your deployment
|
|
crewai deploy logs
|
|
|
|
# Push updates after code changes
|
|
crewai deploy push
|
|
|
|
# Remove a deployment
|
|
crewai deploy remove <deployment_id>
|
|
```
|
|
|
|
## Option 2: Deploy Directly via Web Interface
|
|
|
|
You can also deploy your crews directly through the CrewAI Enterprise web interface by connecting your GitHub account. This approach doesn't require using the CLI on your local machine.
|
|
|
|
<Steps>
|
|
|
|
<Step title="Pushing to GitHub">
|
|
|
|
You need to push your crew to a GitHub repository. If you haven't created a crew yet, you can [follow this tutorial](/quickstart).
|
|
|
|
</Step>
|
|
|
|
<Step title="Connecting GitHub to CrewAI Enterprise">
|
|
|
|
1. Log in to [CrewAI Enterprise](https://app.crewai.com)
|
|
2. Click on the button "Connect GitHub"
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="Select the Repository">
|
|
|
|
After connecting your GitHub account, you'll be able to select which repository to deploy:
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="Set Environment Variables">
|
|
|
|
Before deploying, you'll need to set up your environment variables to connect to your LLM provider or other services:
|
|
|
|
1. You can add variables individually or in bulk
|
|
2. Enter your environment variables in `KEY=VALUE` format (one per line)
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="Deploy Your Crew">
|
|
|
|
1. Click the "Deploy" button to start the deployment process
|
|
2. You can monitor the progress through the progress bar
|
|
3. The first deployment typically takes around 10-15 minutes; subsequent deployments will be faster
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
Once deployment is complete, you'll see:
|
|
- Your crew's unique URL
|
|
- A Bearer token to protect your crew API
|
|
- A "Delete" button if you need to remove the deployment
|
|
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
### Interact with Your Deployed Crew
|
|
|
|
Once deployment is complete, you can access your crew through:
|
|
|
|
1. **REST API**: The platform generates a unique HTTPS endpoint with these key routes:
|
|
- `/inputs`: Lists the required input parameters
|
|
- `/kickoff`: Initiates an execution with provided inputs
|
|
- `/status/{kickoff_id}`: Checks the execution status
|
|
|
|
2. **Web Interface**: Visit [app.crewai.com](https://app.crewai.com) to access:
|
|
- **Status tab**: View deployment information, API endpoint details, and authentication token
|
|
- **Run tab**: Visual representation of your crew's structure
|
|
- **Executions tab**: History of all executions
|
|
- **Metrics tab**: Performance analytics
|
|
- **Traces tab**: Detailed execution insights
|
|
|
|
### Trigger an Execution
|
|
|
|
From the Enterprise dashboard, you can:
|
|
|
|
1. Click on your crew's name to open its details
|
|
2. Select "Trigger Crew" from the management interface
|
|
3. Enter the required inputs in the modal that appears
|
|
4. Monitor progress as the execution moves through the pipeline
|
|
|
|
### Monitoring and Analytics
|
|
|
|
The Enterprise platform provides comprehensive observability features:
|
|
|
|
- **Execution Management**: Track active and completed runs
|
|
- **Traces**: Detailed breakdowns of each execution
|
|
- **Metrics**: Token usage, execution times, and costs
|
|
- **Timeline View**: Visual representation of task sequences
|
|
|
|
### Advanced Features
|
|
|
|
The Enterprise platform also offers:
|
|
|
|
- **Environment Variables Management**: Securely store and manage API keys
|
|
- **LLM Connections**: Configure integrations with various LLM providers
|
|
- **Custom Tools Repository**: Create, share, and install tools
|
|
- **Crew Studio**: Build crews through a chat interface without writing code
|
|
|
|
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
|
|
Contact our support team for assistance with deployment issues or questions about the Enterprise platform.
|
|
</Card>
|