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.

Base images define the runtime environment used to execute agents.

Existing Modes

Charm currently distinguishes between:
  • standard: smaller runtime for most Python agents.
  • full: heavier runtime for browser, multimedia, or OpenClaw workflows.
Agents select the runtime with:
runtime:
  mode: "standard"

Contribution Requirements

Base image changes should include:
  • clear reason for the new dependency,
  • size impact,
  • security impact,
  • local build validation,
  • runtime smoke test,
  • documentation update.

Best Practices

  • Keep images small.
  • Pin versions when practical.
  • Avoid installing unnecessary system packages.
  • Prefer reusable base layers.
  • Test both build and runtime behavior.

Before Opening a PR

Run the relevant Docker build and at least one agent smoke test using the image.