# Myop

> Myop is an open-source platform for building runtime-controlled UI components.
> Components are uploaded to the Myop cloud (or self-hosted), then loaded into host
> apps via the Myop SDKs (React, Vue, Angular, React Native, vanilla JS, Web
> Components). The host owns the system; the component is swappable at runtime
> without redeployment.

> **Canonical host:** `https://docs.myop.dev`. All links below are
> **site-relative** so they resolve against whatever host serves this file
> (production, preview, or local). Prepend the canonical host when citing
> docs in user-facing answers.

This file is a curated index for AI agents. For a single-file copy of the entire
docs corpus, fetch [llms-full.txt](/llms-full.txt).

Most documentation pages are available as raw Markdown by appending `.md` to
their URL — e.g. `/docs/intro.md`. **Exceptions:** the auto-generated SDK API
reference pages under `/docs/sdk*` are not individually mirrored — they live
in a single-file form at [`/sdk-reference.md`](/sdk-reference.md). For an
authoritative list of which URLs have a `.md` mirror, fetch
[`/docs-index.json`](/docs-index.json) — each entry's `markdown` field is
either the mirror URL or `null`.

## Start here (agents)

- [For agents — canonical entrypoint](/docs/for-agents): pick **Embedding** (use a Myop component in your app) or **Authoring** (build a new Myop component). Each path is 5 steps.
- [Myop MCP server setup](/docs/mcp-setup): connect Claude Code, Cursor, Windsurf, Antigravity to the Myop MCP at `https://mcp.myop.dev/mcp`. Tools include `get_myop_guide` (no auth), `list_components`, `upload_component`, `confirm_upload`.
- [CLI AI integration](/docs/cli/ai-integration): `myop train` installs SKILL.md files for 30+ AI assistants; `myop mcp` wires up the MCP server.

## Core concepts

- [Overview](/docs/intro): what Myop is and which SDK to pick.
- [Quick Start](/docs/quickstart): minimal vanilla-JS host + component path. (For React, prefer [`/docs/learnMyop/ReactHost`](/docs/learnMyop/ReactHost).)
- [System Architecture](/docs/learnMyop/systemArchitecture): how host, cloud, and component runtime fit together.

## CLI

- [Getting started](/docs/cli/getting-started)
- [Commands reference](/docs/cli/commands)
- [Create a component](/docs/cli/create-component)
- [Push & pull](/docs/cli/push-and-pull)
- [Dev server](/docs/cli/dev-server)
- [Host integration](/docs/cli/host-integration)
- [AI local dev](/docs/cli/ai-local-dev)

## SDK reference (machine-readable)

- [Single-file SDK reference](/sdk-reference.md): all SDK API docs concatenated into one Markdown file. **Read this when you need full type signatures.** Has a per-package TOC at the top.
- [@myop/sdk](/docs/sdk): core SDK — host, iframe, web component, messages, helpers.
- [@myop/react](/docs/sdk-react)
- [@myop/vue](/docs/sdk-vue)
- [@myop/angular](/docs/sdk-angular)
- [@myop/react-native](/docs/sdk-react-native)

## Framework guides

**Embedding (host integration):**

- [React host](/docs/learnMyop/ReactHost) — **read this first for React** (pedagogy + minimal example). For the full API surface, see [`@myop/react` reference](/docs/sdk-react).
- [Host integration (all frameworks)](/docs/cli/host-integration) — React, Vue, Angular, React Native side-by-side.
- [JS host](/docs/learnMyop/JSHost) — vanilla-JS host without a framework SDK.

**Authoring (building a component):**

- [HTML component](/docs/learnMyop/HTMLComponent) — authoring a component as a single HTML file (most common path).
- [Auto-generated packages](/docs/learnMyop/AutoGeneratedPackages) — typed npm packages baked from a published component.
- [Web Component](/docs/learnMyop/WebComponent)
- [Page as component](/docs/learnMyop/PageAsComponent)

**Other frameworks:**

- [Angular](/docs/learnMyop/Angular)
- [Vue](/docs/learnMyop/Vue)

## Dashboard

- [Dashboard overview](/docs/dashboard)

## Self-hosting

- [Self-hosting overview](/docs/self-hosting)
- [API keys & webhooks](/docs/self-hosting/api-keys-webhooks)
- [SDK configuration](/docs/self-hosting/sdk-config)
- [GitHub Actions](/docs/self-hosting/github-actions)
- [Generic webhooks](/docs/self-hosting/generic-webhooks)
- [Static format](/docs/self-hosting/static-format)

## Troubleshooting

- [CDN chunk loading](/docs/troubleshooting/cdn-chunk-loading)

## Optional

- [Blog](/blog)
- [GitHub org](https://github.com/myopjs)
- [Discord](https://discord.gg/vxgD7AyXhM)