> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crewship.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Deploy your first AI agent in under 5 minutes

## Prerequisites

Before you begin, make sure you have:

* A **Crewship account** ([sign up here](https://console.crewship.dev))
* An agent project ready to deploy — CrewAI, LangGraph, or LangGraph.js

<Tip>
  Don't have a project yet? Clone one of our quickstart repos and deploy it in minutes:

  * [langgraph-quickstart](https://github.com/Crewship/langgraph-quickstart) — LangGraph (Python)
  * [langgraph-js-quickstart](https://github.com/Crewship/langgraph-js-quickstart) — LangGraph.js (TypeScript)
  * [crewai-quickstart](https://github.com/Crewship/crewai-quickstart) — CrewAI (Python)
</Tip>

## Install the CLI

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={null}
    curl -fsSL https://www.crewship.dev/install.sh | bash
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    Invoke-WebRequest -Uri "https://api.crewship.dev/cli/releases/latest/download?platform=windows-x64" -OutFile "$env:LOCALAPPDATA\Programs\crewship.exe"
    [Environment]::SetEnvironmentVariable("Path", "$([Environment]::GetEnvironmentVariable('Path', 'User'));$env:LOCALAPPDATA\Programs", "User")
    ```

    Restart your terminal after running these commands.
  </Tab>
</Tabs>

## Authenticate

Login to connect the CLI to your Crewship account:

```bash theme={null}
crewship login
```

This opens a browser window to authenticate. Once complete, your credentials are stored locally.

<Tip>Run `crewship whoami` to verify your authentication status.</Tip>

## Add Crewship Configuration

Crewship currently supports CrewAI, LangGraph, and LangGraph.js. If you already have a project in one of these frameworks, you can deploy it on Crewship.

If you want to deploy an agent built with a framework that we don't (yet) support, please send us a message at [mail@crewship.dev](mailto:mail@crewship.dev) so we can prioritize it!

Initialize a `crewship.toml` file in your project:

```bash theme={null}
crewship init
```

This auto-detects your framework and entrypoint:

<Tabs>
  <Tab title="CrewAI">
    ```
    🔍 Initializing Crewship project in /path/to/my_crew

       Found pyproject.toml, reading project info...
       Detected CrewAI project
       Detected entrypoint: my_crew.crew:MyCrew

    ✅ Created crewship.toml
    ```
  </Tab>

  <Tab title="LangGraph">
    ```
    🔍 Initializing Crewship project in /path/to/my_agent

       Found langgraph.json, reading project info...
       Detected LangGraph project
       Detected entrypoint: src.my_agent.graph:graph

    ✅ Created crewship.toml
    ```
  </Tab>

  <Tab title="LangGraph.js">
    ```
    🔍 Initializing Crewship project in /path/to/my_agent

       Found langgraph.json, reading project info...
       Detected LangGraph.js project
       Detected entrypoint: ./src/graph.ts:graph

    ✅ Created crewship.toml
    ```
  </Tab>
</Tabs>

<Tip>
  The `init` command automatically finds your entrypoint. You can also create `crewship.toml` manually — see the [configuration reference](/configuration/crewship-toml).
</Tip>

## Deploy

Deploy your crew with a single command:

```bash theme={null}
crewship deploy
```

You'll see output like:

```
📦 Packaging crew...
☁️  Uploading build context...
🔨 Building image...
✅ Deployed successfully!

Deployment: dep_abc123xyz
Production URL: https://my-crew.crewship.run
```

<Tip>You can also simply `run crewship deploy` in a new project, and it will log you in and initialize the project configuration automatically.</Tip>

## Invoke Your Agent

Run your deployed agent:

<CodeGroup>
  ```bash CLI theme={null}
  crewship invoke --input '{"topic": "AI agents"}'
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.crewship.dev/v1/runs \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "deployment": "my-crew",
      "input": {"topic": "AI agents"}
    }'
  ```
</CodeGroup>

## Stream Events

Watch your agent execute in real-time:

```bash theme={null}
crewship invoke --input '{"topic": "AI agents"}' --stream
```

Events stream as they happen:

```
▶ Run started: run_xyz789
├─ [10:30:01] Starting execution
├─ [10:30:02] Agent: Researcher starting task...
├─ [10:30:25] Agent: Researcher completed task
├─ [10:30:26] Agent: Writer starting task...
├─ [10:30:58] Agent: Writer completed task
├─ [10:30:59] Artifact: report.md (2.4 KB)
✅ Run completed in 58.4s
```

## View in Console

Open the [Crewship Console](https://console.crewship.dev) to:

* View run history and logs
* Download artifacts
* Manage environment variables
* Monitor usage and costs

## Next Steps

<CardGroup cols={2}>
  <Card title="Core Concepts" icon="book" href="/concepts">
    Understand deployments, runs, and artifacts
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/cli/overview">
    Explore all CLI commands
  </Card>

  <Card title="Environment Variables" icon="key" href="/configuration/environment-variables">
    Configure secrets and API keys
  </Card>

  <Card title="Streaming Guide" icon="bolt" href="/guides/streaming">
    Real-time event streaming in depth
  </Card>
</CardGroup>