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.

charm.yaml is the manifest that tells Charm how to display, run, price, and publish an agent.

​
Planned Sections

  • version
  • persona
  • pricing
  • auth
  • interface
  • runtime
  • policies
  • workflow

​
Minimal Shape

version: "0.4.3"

persona:
  name: "My Agent"
  version: "0.1.0"
  description: "A short description."
  authors: ["Your Name"]
  tags: ["productivity"]
  license: "MIT"

interface:
  input:
    type: "object"
    required: ["message"]
    properties:
      message:
        type: "string"
        title: "Message"
  output:
    type: "object"
  state:
    format: "json"
    schema:
      type: "object"
      properties:
        memory:
          type: "string"

runtime:
  adapter:
    type: "custom"
    entry_point: "src.main:agent"
  config:
    system_prompt: "You are a helpful assistant."
    model: "gpt-4o"
    temperature: 0.0
  mode: "standard"
  lifecycle: "serverless"

​
Field Groups

​
version

The manifest contract version supported by the installed SDK.

​
persona

Public metadata used in the Store, docs, and release history.

​
pricing

Optional commercial metadata such as free, one-time, or subscription pricing.

​
auth

Optional OAuth requirements. The Store uses this to prompt users to connect provider accounts before a run.

​
interface

JSON Schema-style input, output, and optional state definitions. These control the generated UI and persistent memory structures.

​
runtime

Adapter, entry point, engine configuration (config), lifecycle, mode, skills, and environment variable requirements.

​
policies

Execution limits and permissions, such as internet access or max steps.

​
Lifecycle Values

  • serverless: short-lived execution.
  • interactive: real-time streaming.
  • daemon: long-running background execution.