breakdown

Breakdown 使用ガイド

このドキュメントでは、Breakdownツールの様々なユースケースとコマンドパターンについて説明します。

インストール

推奨: CLIとしてインストール

BreakdownはCLIツールとしての利用が主目的です。
Deno公式/JSR標準の方法で、以下のコマンドでインストールできます。

deno install -A -f --global breakdown jsr:@tettuan/breakdown

Note:
CLIモジュールはjsr:@tettuan/breakdownで指定する必要があります。
これはdeno.jsonのexports設定に基づいています。

アップデート

新しいバージョンが公開された場合も、同じコマンドで上書きインストールできます。

deno install -A -f --global breakdown jsr:@tettuan/breakdown

ライブラリとして使う場合

TypeScript/JavaScriptから直接importして使う場合は、
deno add で依存に追加できます。

deno add @tettuan/breakdown

注意事項

プロジェクトディレクトリへのローカルインストール

特定のプロジェクト内でのみbreakdownコマンドを使用したい場合は、--rootオプションを使用して.deno/binにインストールできます：

deno install -A -f --global --root .deno -n breakdown jsr:@tettuan/breakdown

インストール後、binディレクトリをPATHに追加します：

export PATH="$(pwd)/.deno/bin:$PATH"

この設定を永続化するには、シェルの設定ファイル（例：~/.zshrcや~/.bashrc）に追加してください。

トラブルシューティング

コマンドが応答しない場合は、以下の手順を試してください：

  1. インストールの確認: 
    which breakdown
  2. 直接実行でテスト: 
    deno run --allow-all jsr:@tettuan/breakdown
  3. バイナリとしてコンパイル: 
    deno compile -A -o ~/.deno/bin/breakdown jsr:@tettuan/breakdown
  4. パスの確認: 
    echo $PATH

基本コマンド

作業ディレクトリの初期化

breakdown init

このコマンドは、設定で指定された必要な作業ディレクトリ構造を作成します。

Markdownの加工コマンド

以下の組み合わせになります。

Command \ Layer コマンドの説明 Project Issue Task
to 入力されたMarkdownを次のレイヤー形式に変換するコマンド プロジェクトへ分解
breakdown to project -o=		 プロジェクトから課題へ分解
breakdown to issue <project_summary.md|written_issue.md> -o=		 課題からタスクへ分解
breakdown to task <issue.md|written_task.md> -o=
summary 新規のMarkdownを生成、または指定レイヤーのMarkdownを生成するコマンド プロジェクト概要をMarkdown形式で生成
echo “" | breakdown summary project -o=		 イシュー概要をMarkdown形式で生成
breakdown summary issue –from= --input=task -o=		 タスク概要をMarkdown形式で生成
breakdown summary task –from= -o=
defect エラーログや不具合情報から修正を生成するコマンド 不具合情報からプロジェクト情報を生成
tail -100 “" | breakdown defect project -o=		 不具合情報から課題を生成
breakdown defect issue –from= -o=		 不具合情報からタスクを生成
breakdown defect task –from= -o=

プロジェクトへの分解

breakdown to project <written_project_summary.md> -o=<project_dir>

課題への分解

breakdown to issue <project_summary.md|written_issue.md> -o=<issue_dir>

タスクへの分解

breakdown to task <issue.md|written_task.md> -o=<tasks_dir>

Markdownサマリーの生成

プロジェクトサマリー 未整理の情報からプロジェクト概要を生成：

echo "<messy_something>" | breakdown summary project -o=<project_summary.md>

イシューサマリー タスク群から課題を生成：

breakdown summary issue --from=<aggregated_tasks.md> --input=task -o=<issue_markdown_dir>

タスクサマリー 未整理のタスク情報から整理されたタスクを生成：

breakdown summary task --from=<unorganized_tasks.md> -o=<task_markdown_dir>
This site is open source. Improve this page.