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.

Adapters let Charm support different agent frameworks behind a shared runner interface.

​
When to Add an Adapter

Add an adapter when a framework has a distinct execution model that cannot be cleanly handled by the existing adapters.

​
Adapter Responsibilities

An adapter should define how to:
  • load the user’s entry point,
  • pass inputs into the framework,
  • stream or return output,
  • surface errors,
  • handle tools or state when supported.

​
Development Steps

  1. Study the closest existing adapter.
  2. Add the adapter implementation.
  3. Register the adapter type.
  4. Add or update manifest validation.
  5. Add a minimal template or example.
  6. Add tests.
  7. Update docs.

​
Testing

Test locally with: 
charm validate path/to/example
charm run path/to/example --input "Hello"
Use Docker mode if the adapter depends on runtime image behavior.