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

# Installation

> Install `cpsl`, verify the `capsule` CLI, and authenticate to your workspace.

Install `cpsl`, verify the `capsule` CLI, then authenticate to your workspace.

The package includes both pieces:

* `cpsl`, the Python API you write your app with
* `capsule`, the CLI you use for `login`, `serve`, `deploy`, secrets, channels, and filesystems

## Requirements

* Python `3.10+`
* a virtual environment or `uv` project
* access to a Capsule workspace if you want to `serve`, `deploy`, manage secrets, create channels, or mount filesystems

## Install with uv

```bash theme={null}
uv add cpsl
```

Or install into a virtual environment directly:

```bash theme={null}
uv venv
source .venv/bin/activate
uv pip install cpsl
```

## Install with pip

```bash theme={null}
python -m venv .venv
source .venv/bin/activate
pip install cpsl
```

## Verify the CLI

```bash theme={null}
which capsule
capsule --help
```

You should see command groups such as:

```text theme={null}
create
login
app
channel
deploy
fs
secret
serve
```

## Authenticate to your workspace

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

This opens a browser, authenticates against your workspace, and stores a local token for platform commands.

`serve`, `deploy`, `secret`, `channel`, and `fs` all talk to Capsule, so login is part of normal local setup.

## Scaffold a project

Use `create` when you want a template instead of a blank `app.py`:

```bash theme={null}
capsule create my-agent-app --template quickstart
cd my-agent-app
uv sync
```

The create command can generate:

* `quickstart` for a BAML-backed assistant with packaged context
* `media-studio` for generated media in chat
* `browser-agent` for browser workflows
* `background-agent` for scheduled agent loops

Start with `quickstart` for the main path, then use `media-studio`, `browser-agent`, or `background-agent` when you want a more specialized starter.

## Next steps

* Follow the [Quickstart](/quickstart).
* Build the [First Chat App](/build/first-chat-app).
* Use [Troubleshooting](/troubleshooting) if setup fails.
* See [CLI Reference](/reference/cli) for the full command surface.