CLI
charm init
Scaffold a new Charm agent project.
Start an interactive prompt for template selection:
Create a single file from a template:
After scaffolding, run:
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
charm init <name> [--template <template>] [--create <file>] [--interactive]
charm init my-agent --template python
charm init my-agent --interactive
charm init . --create charm.yaml
| Option | Description |
|---|---|
name | Agent directory path. Use . for the current directory. |
--template | Template to use. Defaults to python. Valid values are fetched dynamically from the community templates registry (e.g., python, openclaw, slack-bot). |
--create | Create a single file instead of a full project. |
--interactive, -i | Launch guided template selection. |
my-agent/
├── charm.yaml
├── requirements.txt or pyproject.toml
└── src/
└── main.py
cd my-agent
charm validate .
charm run . --input "Hello"
