From 49d0590ac52d653b7b82fe6e2e0d23d185b84ccc Mon Sep 17 00:00:00 2001 From: Mary Cutrali Date: Wed, 20 May 2026 10:56:32 -0500 Subject: [PATCH 1/3] docs: add agent skills page and llms.txt callout Document the miren-skills plugin with installation instructions for Claude Code, Codex, Amp, Pi, and OpenCode. Add a tip to the intro page pointing AI coding agents at llms.txt and the skills repo. --- docs/docs/agent-skills.md | 90 +++++++++++++++++++++++++++++++++++++++ docs/docs/intro.md | 4 ++ docs/sidebars.ts | 1 + 3 files changed, 95 insertions(+) create mode 100644 docs/docs/agent-skills.md diff --git a/docs/docs/agent-skills.md b/docs/docs/agent-skills.md new file mode 100644 index 00000000..1abe02fc --- /dev/null +++ b/docs/docs/agent-skills.md @@ -0,0 +1,90 @@ +--- +title: Agent Skills +description: Use AI coding agents to deploy, diagnose, and manage your Miren infrastructure with pre-built skills for Claude Code, Codex, Amp, and more. +keywords: [miren, agent skills, claude code, codex, amp, ai, llm] +--- + +# Agent Skills + +You shouldn't have to context-switch out of your editor to deploy an app or check why something's unhealthy. Miren's agent skills let your AI coding agent operate your infrastructure directly — deploy, diagnose, and manage apps without leaving the conversation. + +The skills work with [Claude Code](https://claude.ai/code), [Codex](https://github.com/openai/codex), [Amp](https://ampcode.com), [Pi](https://github.com/anthropics/pi), and [OpenCode](https://github.com/opencode-ai/opencode). Source and setup instructions are at [github.com/mirendev/miren-skills](https://github.com/mirendev/miren-skills). + +## Installation + +### Claude Code + +```bash +/plugin marketplace add mirendev/miren-skills +/plugin install miren@miren +``` + +### Codex CLI + +```bash +mkdir -p ~/.agents/skills +cp -r /path/to/miren-skills/.agents/skills/* ~/.agents/skills/ +``` + +### Amp + +From the command palette (`Ctrl+O` in CLI, `Cmd+Shift+P` in VS Code): + +``` +skill: add https://github.com/mirendev/miren-skills +``` + +### Pi + +```bash +pi install git:github.com/mirendev/miren-skills +``` + +### OpenCode + +```bash +mkdir -p ~/.config/opencode/skills +cp -r /path/to/miren-skills/.agents/skills/* ~/.config/opencode/skills/ +``` + +## What's included + +### `use-miren` + +The core skill. Once installed, your agent knows how to use the `miren` CLI — it discovers commands via `miren help`, targets clusters with `-C`, and uses `--json` output for reliable parsing. You don't need to teach it anything; just mention Miren and it kicks in. + +### `app-setup` + +Getting a new app onto Miren means figuring out what it needs — env vars, databases, services, build config — and wiring it all up. This agent does the detective work for you. Point it at your source code and it walks you through the whole setup, from stack detection to a working `.miren/app.toml`. + +Try asking: +- "Help me set up this app on Miren" +- "What does this app need to run?" + +### `app-health` + +Instead of piecing together app status from multiple commands, ask your agent to check on an app. It pulls together service states, deployment history, logs, and diagnostics into a single report with actionable recommendations. Defaults to the app in your current directory. + +Try asking: +- "How's this app doing?" +- "Check the health of myapp" + +### `cluster-health` + +Same idea, but across your whole cluster. Surveys every app and service, then gives you a prioritized breakdown — what's healthy, what needs attention, and what to do about it. + +Try asking: +- "How's the cluster looking?" +- "Give me a health check on garden" + +## Commands reference + +The skills teach agents to discover commands on their own via `miren help`: + +```bash +miren help --commands # list all commands +miren help app.list # help for a specific command (use . for spaces) +miren help "app list" # alternative: quote the command +``` + +Most commands accept `-C ` to target a specific cluster. diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 1df4d961..3eff46b8 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -5,6 +5,10 @@ description: Miren is a container platform for small teams — deploy apps to a keywords: [miren, container platform, deploy, self-hosted, paas] --- +:::tip[Working with an AI coding agent?] +Point it at [llms.txt](https://miren.md/llms.txt) or [llms-full.txt](https://miren.md/llms-full.txt) for LLM-friendly docs, or install [Miren agent skills](https://github.com/mirendev/miren-skills) so it can deploy and manage your apps directly. +::: + # Miren Miren is a container platform for small teams. You install it on a Linux server, point your CLI at it, and deploy with `miren deploy`. It handles builds, scaling, routing, TLS, and backups so you don't have to stitch together a platform from parts. diff --git a/docs/sidebars.ts b/docs/sidebars.ts index cbcf720f..4c7eeb7f 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -83,6 +83,7 @@ const sidebars: SidebarsConfig = { label: 'Resources', collapsed: false, items: [ + 'agent-skills', 'troubleshooting', 'terminology', 'labs', From d07d9590ce59afc89b1478b1f184cd013b8b31eb Mon Sep 17 00:00:00 2001 From: Mary Cutrali Date: Wed, 20 May 2026 11:00:53 -0500 Subject: [PATCH 2/3] docs: add skills-vs-docs relationship note MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Clarify that skills make docs actionable but the docs remain the authoritative reference — addresses MIR-1052 requirement. --- docs/docs/agent-skills.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/agent-skills.md b/docs/docs/agent-skills.md index 1abe02fc..68dfc821 100644 --- a/docs/docs/agent-skills.md +++ b/docs/docs/agent-skills.md @@ -10,6 +10,10 @@ You shouldn't have to context-switch out of your editor to deploy an app or chec The skills work with [Claude Code](https://claude.ai/code), [Codex](https://github.com/openai/codex), [Amp](https://ampcode.com), [Pi](https://github.com/anthropics/pi), and [OpenCode](https://github.com/opencode-ai/opencode). Source and setup instructions are at [github.com/mirendev/miren-skills](https://github.com/mirendev/miren-skills). +:::note +Skills make these docs faster to act on — your agent can read a page about scaling and immediately run the commands — but the docs remain the authoritative reference. When in doubt, the docs are the source of truth. +::: + ## Installation ### Claude Code From 61b17d9e9c6767c78e40046a7a6d2cd72e0892cd Mon Sep 17 00:00:00 2001 From: Mary Cutrali Date: Wed, 20 May 2026 11:56:08 -0500 Subject: [PATCH 3/3] docs: address review feedback on agent skills page - Fix Pi link to point to pi.dev instead of nonexistent GitHub repo - Replace placeholder paths with git clone workflow for Codex and OpenCode - Add language specifier to Amp code block - Simplify miren help examples (dots/quotes no longer needed per #812) --- docs/docs/agent-skills.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/docs/agent-skills.md b/docs/docs/agent-skills.md index 68dfc821..7353571e 100644 --- a/docs/docs/agent-skills.md +++ b/docs/docs/agent-skills.md @@ -8,7 +8,7 @@ keywords: [miren, agent skills, claude code, codex, amp, ai, llm] You shouldn't have to context-switch out of your editor to deploy an app or check why something's unhealthy. Miren's agent skills let your AI coding agent operate your infrastructure directly — deploy, diagnose, and manage apps without leaving the conversation. -The skills work with [Claude Code](https://claude.ai/code), [Codex](https://github.com/openai/codex), [Amp](https://ampcode.com), [Pi](https://github.com/anthropics/pi), and [OpenCode](https://github.com/opencode-ai/opencode). Source and setup instructions are at [github.com/mirendev/miren-skills](https://github.com/mirendev/miren-skills). +The skills work with [Claude Code](https://claude.ai/code), [Codex](https://github.com/openai/codex), [Amp](https://ampcode.com), [Pi](https://pi.dev), and [OpenCode](https://github.com/opencode-ai/opencode). Source and setup instructions are at [github.com/mirendev/miren-skills](https://github.com/mirendev/miren-skills). :::note Skills make these docs faster to act on — your agent can read a page about scaling and immediately run the commands — but the docs remain the authoritative reference. When in doubt, the docs are the source of truth. @@ -26,15 +26,15 @@ Skills make these docs faster to act on — your agent can read a page about sca ### Codex CLI ```bash -mkdir -p ~/.agents/skills -cp -r /path/to/miren-skills/.agents/skills/* ~/.agents/skills/ +git clone https://github.com/mirendev/miren-skills +cp -r miren-skills/.agents/skills/* ~/.agents/skills/ ``` ### Amp From the command palette (`Ctrl+O` in CLI, `Cmd+Shift+P` in VS Code): -``` +```text skill: add https://github.com/mirendev/miren-skills ``` @@ -47,8 +47,8 @@ pi install git:github.com/mirendev/miren-skills ### OpenCode ```bash -mkdir -p ~/.config/opencode/skills -cp -r /path/to/miren-skills/.agents/skills/* ~/.config/opencode/skills/ +git clone https://github.com/mirendev/miren-skills +cp -r miren-skills/.agents/skills/* ~/.config/opencode/skills/ ``` ## What's included @@ -87,8 +87,7 @@ The skills teach agents to discover commands on their own via `miren help`: ```bash miren help --commands # list all commands -miren help app.list # help for a specific command (use . for spaces) -miren help "app list" # alternative: quote the command +miren help app list # help for a specific command ``` Most commands accept `-C ` to target a specific cluster.