つまり、どういうこと？

ちょっと触ってみた感じだと、README.md の中からコードブロックを抜き出し「説明付きで一覧にしたり」「実行したり」する CLI ツールを作ってみたということのようです。

そう聞くと「それはコードブロックをコピーして実行すればいいんじゃね」となりそうですが、ドキュメント内でのコマンド実行のサンプルは以下のように行頭に $ が付いていたり。実行結果が併記されていたりすることがあります[1]。

rdme はその辺をなんかいい感じに実行してくれます。

リスト 1-1 サンプルの README.md

# テスト

## Installation

```sh
npm install remark-cli

プロンプト付き

$ が付いている場合は、いい感じに処理してくれる。

$ for i in $(seq 1 8); do echo "${i}"; done
1
2
<snip...>
7
8
$ echo "実行してみた"
実行してみた


**図 1-1 run するとコマンドとして成立している部分が実行される**

$ rdme list NAME FIRST COMMAND # OF COMMANDS DESCRIPTION npm-install npm install remark-cli 1 Installation for-i for i in $(seq 1 8); do echo "${i}"... 2 $ が付いている場合は、いい感じに処...

$ rdme run npm-install

added 149 packages, and audited 150 packages in 12s

64 packages are looking for funding run npm fund for details

found 0 vulnerabilities

$ rdme run for-i 1 2 3 4 5 6 7 8 実行してみた


## 入力補完

入力補完にも対応していて `eval “$(rdme completaion bash)` などで利用できるようになります。

これが地味に便利でして、前述のような README の場合で「パッケージをインストールしたいな」と思ったら `rdme run n` で TAB を押下するだけとなります。

## エンジンの指定はちょっとめんどう

「どのエンジン(コマンド)を使ってコードを実行するか？」はコードブロックの言語指定で決まるようで、ここに `console` などを指定していると以下のようになってしまいます[[2]](<https://zenn.dev/hankei6km/articles/readmemd-has-been-run-in-my-terminal#fn-f943-2>)。

**図 3-1 言語指定が console だとエラーになる**

$ head -n 11 README.md

xquo

Command line utility to quote null splited lines for Bash command line.

Installation

Using `cargo`

$ cargo install xquo

$ rdme run cargo-install unknown executable: "console"

つまり、どういうこと？

プロンプト付き

xquo

Installation

Using cargo

Using `cargo`