Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.charmos.io/llms.txt

Use this file to discover all available pages before exploring further.

Install Charm locally so you can create, validate, run, and publish agents from your terminal.

​
Prerequisites

Before installing Charm, make sure you have:
  • Python 3.10 or newer.
  • pip or uv.
  • Git.
  • Docker Desktop or Docker Engine if you want to test agents in the local container sandbox.
uv is recommended because it creates fast, reproducible Python environments.

​
Install with uv

For agent development: 
uv add charmos
For local runner and Docker sandbox testing: 
uv add "charmos[runner]"

​
Install with pip

For agent development: 
pip install charmos
For local runner and Docker sandbox testing: 
pip install "charmos[runner]"

​
Verify the CLI

Run: 
charm --help
You should see the available Charm commands, including init, run, validate, push, logs, and auth.

​
Optional: Create a Project Virtual Environment

If you are working inside an agent repository, create and activate a virtual environment first. 
python -m venv .venv
On macOS or Linux: 
source .venv/bin/activate
On Windows PowerShell: 
.\.venv\Scripts\Activate.ps1
Then install Charm: 
pip install "charmos[runner]"

​
Optional: Docker Sandbox

Charm can run agents locally in a container that more closely matches the cloud runtime. To use sandbox mode:
  1. Install charmos[runner].
  2. Start Docker.
  3. Run your agent with --docker.
charm run . --input "Hello from Docker" --docker

​
Next Step

Continue to Build Your First Agent.