AgentSkillsCN

runme-conventions

Runme.dev 格式的可执行 Markdown 创建与编辑规范。 使用时机： (1) 在 Markdown 文件中添加可执行代码块（verify.md、README.md 等） (2) 添加或编辑 Runme.dev 单元设置（name、cwd、excludeFromRunAll 等） (3) 应用 runme fmt 格式 (4) 修改或改进现有 Runme 文件

SKILL.md
--- frontmatter
name: runme-conventions
description: |
  Runme.dev形式の実行可能マークダウン作成・編集用規約。
  使用タイミング:
  (1) マークダウンファイルに実行可能なコードブロックを追加（verify.md, README.mdなど）
  (2) Runme.devセル設定の追加・編集（name, cwd, excludeFromRunAllなど）
  (3) runme fmtでフォーマット適用
  (4) 既存Runmeファイルの修正・改善
allowed-tools: Read, Bash(runme fmt:*)

Runme.dev規約

クイックスタート

コードブロックにJSON形式でセル設定を追加:

markdown
```bash {"name":"deploy","cwd":"../mcp-server"}
npm run deploy
```

主要オプション

オプション説明例
nameタスク名（runme run <name>で実行）{"name":"deploy"}
cwd作業ディレクトリ（mdファイルからの相対パス）{"cwd":"../mcp-server"}
excludeFromRunAllrunme run --allから除外{"excludeFromRunAll":"true"}
ignoreCLI・ノートブック変換から完全除外（runme listにも表示されない）{"ignore":"true"}

フォーマット

コミット前にrunme fmtを実行してVSCode拡張機能との差分を防止:

bash
runme fmt -w --filename <target.md>

詳細リファレンス