Development Environment

​

Prerequisites

• Python 3.10 or newer.
• Git.
• uv.
• Docker Desktop or Docker Engine for runner and sandbox testing.

​

Clone the Repository

git clone https://github.com/CharmAIOS/Charm.git
cd Charm

​

Create a Virtual Environment

uv venv

source .venv/bin/activate

.\.venv\Scripts\Activate.ps1

​

Install Development Dependencies

uv pip install -e ".[runner,dev]"

​

Build the Local Runner Base Image

docker build -f Dockerfile.base -t charm-runner-base:latest .

​

Run Tests

pytest

​

Validate a Template

charm init /tmp/my-agent --template python
charm validate /tmp/my-agent

​

Before Opening a PR

• Run relevant tests.
• Update docs when behavior changes.
• Avoid committing secrets or local environment files.
• Fill out the PR template with test evidence and release notes.