- ドキュメント内のコードスニペットを実際に実行可能にし、runbook・運用ドキュメント・READMEの有用性と信頼性を高めるために開発
- Markdownのコードブロックをそのまま実行し、ドキュメントをステップごとに簡単に追いながら検証可能
- コマンドを実行し、中間結果を確認し、望む出力が達成されたかを確認
- Shell/Bash、Python、JavaScript/TypeScript、Rubyなど多様なランタイムをshebangベースでサポート
- コードセル実行時に環境変数と実行コンテキストを維持し、ターミナルセッションのように段階的に実行可能
- 前のセルの出力結果を次のセルへ渡すパイプライン型の実行フローにも対応
- Makefile、npm scripts、Gradle、Deno taskなど既存のタスク定義と完全互換
run、list、printコマンドにより、ドキュメント内の実行可能なワークフローを探索・実行・検証可能- 運用ドキュメントのbitrot問題を減らし、段階的な実行が必要な実務ドキュメントに特に適している
- bitrot : ドキュメントやコードが時間の経過とともに実際の環境とずれ、徐々に信頼を失う現象
- Homebrew、npm、Go install、単一バイナリなどでインストール可能
- Apache 2.0ライセンス
まだコメントはありません。