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.

Scaffold a new Charm agent project.

Usage

charm init <name> [--template <template>] [--create <file>] [--interactive]

Common Examples

Create a minimal Python agent:
charm init my-agent --template python
Start an interactive prompt for template selection:
charm init my-agent --interactive
Create a single file from a template:
charm init . --create charm.yaml

Options

OptionDescription
nameAgent directory path. Use . for the current directory.
--templateTemplate to use. Defaults to python.
--createCreate a single file instead of a full project.
--interactive, -iLaunch guided template selection.

Generated Structure

Most templates produce:
my-agent/
├── charm.yaml
├── requirements.txt or pyproject.toml
└── src/
    └── main.py
After scaffolding, run:
cd my-agent
charm validate .
charm run . --input "Hello"