> ## 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

<img src="https://mintcdn.com/charm-ec7e1290/0t4ebE4qEE035_co/assets/banner.png?fit=max&auto=format&n=0t4ebE4qEE035_co&q=85&s=1c9e90b5cbb35f35def412e8ef7edc1c" alt="Charm Banner" noZoom style={{ width: '100%', marginTop: '1rem', marginBottom: '1.5rem' }} width="2211" height="572" data-path="assets/banner.png" />

<div style={{ textAlign: 'center', fontFamily: 'monospace', fontSize: '1.1rem', marginBottom: '3rem' }}>
  Bring your AI agents to everyday users
</div>

<CardGroup cols={2}>
  <Card title="Get Started" icon="rocket-launch" color="#E8A694" href="quickstart/install">
    Install the Charm CLI and publish your first AI agent in minutes.
  </Card>

  <Card title="Onboarding" icon="terminal" color="#E8A694" href="guides/onboarding">
    Walk through the onboarding guide.
  </Card>

  <Card title="Templates" icon="book-open" color="#E8A694" href="templates/overview">
    Start from a prebuilt template.
  </Card>
</CardGroup>

## What is Charm?

**Charm** is a unified application layer that provides a standardized architecture for distributing, running, and scaling AI agents across heterogeneous ecosystems — turning them into real, commercial-ready applications with a single manifest file and a few CLI commands.

### Why Charm?

* **Ecosystem Agnostic**: Bring your own framework such as CrewAI, LangChain, LangGraph, OpenClaw, or plain Python functions, Charm wraps them all with the same runtime contract.
* **No Infrastructure**: The Cloud Runner handles isolated container execution, secrets injection, and scaling. You write agent logic, not deployment pipelines.
* **Server-Driven UI**: Return Markdown or structured JSON from your agent and the Store renders timelines, comparison tables, viral cards, and article layouts automatically - no frontend code needed.
* **Built-In Monetization**: Set pricing in `charm.yaml` and Charm handles checkout, subscriptions, balance checks, and payouts.
* **Open Source**: Charm Core, CLI, and runtime adapters are fully open source. Community contributions drive every part of the ecosystem.

## Who needs Charm?

* **AI Developers** who have a working agent in CrewAI, LangChain, OpenClaw, or custom Python and want to ship it as a product without building infrastructure.
* **AI Builders** who want to monetize agents through the Charm Store with built-in billing, OAuth, and a hosted runtime.
* **Everyday users** who want agents as apps, not infrastructure. Zero setup, no API keys, and no need to understand how they work. Just natural interaction with the agents you need.

## What do you need?

* **Python 3.10+** and `pip` or [`uv`](https://github.com/astral-sh/uv) for package management.
* **Docker Desktop** (optional) if you want to test agents locally in an isolated container sandbox that mirrors the cloud runtime.
* **A Charm account** for publishing to the Store — sign up at [store](\{store_url}).

## How it works

<Frame>
  <img className="rounded-xl w-full" src="https://mintcdn.com/charm-ec7e1290/Gz0oaejzstUYXxEd/assets/how-it-works.png?fit=max&auto=format&n=Gz0oaejzstUYXxEd&q=85&s=ec4e4b0a88245ed53fb8eedea7fb66b0" alt="How it works" width="2048" height="1780" data-path="assets/how-it-works.png" />
</Frame>

***

## Start Here

<Tabs>
  <Tab title="OS">
    <CardGroup cols={2}>
      <Card title="Configuration" icon="gear" color="#E8A694" href="guides/manifest">
        Define everything about your agent in a single charm.yaml manifest.
      </Card>

      <Card title="Run & Test" icon="terminal" color="#E8A694" href="guides/local-run">
        Execute your agent locally or simulate the cloud environment in Docker.
      </Card>
    </CardGroup>
  </Tab>

  <Tab title="Platform">
    <CardGroup cols={2}>
      <Card title="Charm Store" icon="store" color="#E8A694" href="platform/store">
        Publish agents as hosted web apps.
      </Card>

      <Card title="Charm Studio" icon="chart-line" color="#E8A694" href="platform/studio">
        Monitor executions, revenue, and more from your agent center.
      </Card>
    </CardGroup>
  </Tab>
</Tabs>

## Highlight Features

<CardGroup cols={2}>
  <Card title="Secrets Management" icon="key" color="#E8A694" href="platform/keys">
    Fully managed secrets for your agents.
  </Card>

  <Card title="OAuth" icon="shield-halved" color="#E8A694" href="platform/oauth">
    Integrate with Google, GitHub, and more.
  </Card>

  <Card title="Ambient Desktop Companion" icon="display" color="#E8A694" href="platform/ambient-desktop-companion">
    Run agents in your desktop as a native companion.
  </Card>

  <Card title="Payments" icon="money-bill-1" color="#E8A694" href="platform/app">
    Set flexible pricing model in charm.yaml.
  </Card>
</CardGroup>

## Community & Resources

<CardGroup cols={2}>
  <Card title="Charm Store" icon="house" color="#E8A694" href="{store_url}">
    Browse and run published agents on the live storefront.
  </Card>

  <Card title="Contact Us" icon="envelope" color="#E8A694" href="https://charmos.io/contact">
    Reach the core team for partnership, support, or enterprise inquiries.
  </Card>

  <Card title="Discord" icon="discord" color="#E8A694" href="https://discord.gg/gdakynHUEb">
    Get help, share agents, and discuss ideas with other builders.
  </Card>

  <Card title="Blog" icon="blog" color="#E8A694" href="https://charmos.io/blog">
    Follow platform updates, feature announcements, and builder spotlights.
  </Card>
</CardGroup>