runme-conventions
Runme.dev形式の実行可能マークダウン作成・編集用規約。使用タイミング:(1) マークダウンファイルに実行可能なコードブロックを追加(verify.md, README.mdなど)(2) Runme.devセル設定の追加・編集(name, cwd, excludeFromRunAllなど)(3) runme fmtでフォーマット適用(4) 既存Runmeファイルの修正・改善
When & Why to Use This Skill
This Claude skill implements Runme.dev conventions to transform static Markdown files into interactive, executable documentation. It enables the creation and management of executable code blocks with specific metadata, such as task names and working directories, ensuring that runbooks and READMEs are both human-readable and machine-runnable. By integrating with the Runme CLI, it helps maintain documentation consistency and streamlines DevOps workflows through automated formatting and standardized cell configurations.
Use Cases
- Interactive Runbooks: Creating executable verify.md or deploy.md files where developers can run infrastructure commands directly from the documentation.
- Project Onboarding: Setting up README.md files with named code blocks that allow new team members to execute setup scripts with a single command.
- Workflow Automation: Configuring complex cell settings like 'cwd' (current working directory) and 'excludeFromRunAll' to manage multi-step deployment sequences.
- Documentation Maintenance: Using the 'runme fmt' tool integration to automatically format markdown files, preventing style inconsistencies in version control.
| name | runme-conventions |
|---|---|
| description | | |
| allowed-tools | Read, Bash(runme fmt:*) |
Runme.dev規約
クイックスタート
コードブロックにJSON形式でセル設定を追加:
```bash {"name":"deploy","cwd":"../mcp-server"}
npm run deploy
```
主要オプション
| オプション | 説明 | 例 |
|---|---|---|
name |
タスク名(runme run <name>で実行) |
{"name":"deploy"} |
cwd |
作業ディレクトリ(mdファイルからの相対パス) | {"cwd":"../mcp-server"} |
excludeFromRunAll |
runme run --allから除外 |
{"excludeFromRunAll":"true"} |
ignore |
CLI・ノートブック変換から完全除外(runme listにも表示されない) | {"ignore":"true"} |
フォーマット
コミット前にrunme fmtを実行してVSCode拡張機能との差分を防止:
runme fmt -w --filename <target.md>
詳細リファレンス
- 全セルオプション: references/cell-options.md
- ベストプラクティス: references/best-practices.md
- 公式ドキュメント: https://docs.runme.dev/configuration/cell-level