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.

Run agents locally while you iterate on code and manifest changes.

​
Simple Input

charm run . --input "Hello"

​
Structured JSON Input

charm run . --json '{"message": "Hello", "tone": "friendly"}'
Use field names that match interface.input.properties in charm.yaml.

​
Test Case File

charm run . --input-file tests.json
Example: 
[
  {
    "name": "Greeting",
    "input": {
      "message": "Hello"
    }
  }
]

​
Environment Variables

For local development, put non-production values in .env: 
OPENAI_API_KEY=...
TAVILY_API_KEY=...
Never commit .env files containing secrets.

​
Docker Mode

charm run . --input "Hello" --docker
Use Docker mode before publishing when dependencies or runtime behavior may differ from your host machine.