> ## 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.

# Configuration

Depending on your project status, choose the path that fits you best.

Path A: Start a new project

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
charm init my-agent --template python
cd my-agent
```

For an OpenClaw-heavy starter, use `charm init my-agent --template openclaw` instead.

Path B: Create the file manually

1. Create a file named charm.yaml in your project root

> The charm.yaml file must always be at the root level of your project

```plaintext theme={"theme":{"light":"min-light","dark":"min-dark"}}

my-agent/             <-- Project Root
├── charm.yaml        <-- The Manifest
├── pyproject.toml / requirements.txt / package.json   <-- Dependencies
└── src/
    └── main.py       <-- Your Agent Logic
```

1. Copy the Annotated Reference below for use in your configuration

2. Update the field with your existing agent project

### IDE Setup

By configuring your editor, you get auto-completion and error checking. This is crucial for avoiding typos.

1. Create .vscode/settings.json in your project root.

```json theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  "yaml.schemas": {
    "https://raw.githubusercontent.com/CharmAIOS/Charm/main/src/charm/contracts/uac.v0.4.2.schema.json": "charm.yaml"
  }
}
```

For a complete schema definition and all available fields, please consult the [Manifest Reference](/references/manifest).