breakdown

Breakdown Usage Guide

This document explains various use cases and command patterns for the Breakdown tool.

Installation

Recommended: Install as CLI

Breakdown is primarily designed for use as a CLI tool.
You can install it using the official Deno/JSR standard method with the following command:

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

• -A : Allow all permissions (recommended)
• -f : Overwrite existing commands
• --global : Global installation
• breakdown : Command name

Note:
The CLI module must be specified as jsr:@tettuan/breakdown.
This is based on the exports configuration in deno.json.

---

Updates

When a new version is released, you can overwrite the installation using the same command:

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

---

Using as a Library

When importing directly from TypeScript/JavaScript,
you can add it as a dependency using deno add:

deno add @tettuan/breakdown

---

Notes

• The breakdown command automatically uses cli/breakdown.ts as the entry point based on the bin configuration in deno.json.
• Deno 1.40 or later is recommended.
• For detailed usage instructions, refer to the “Usage” section below.

Local Installation to Project Directory

If you want to use the breakdown command only within a specific project, you can install it to .deno/bin using the --root option:

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

After installation, add the bin directory to your PATH:

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

To make this setting persistent, add it to your shell configuration file (e.g., ~/.zshrc or ~/.bashrc).

Troubleshooting

If the command is not responding, try the following steps:

1. Verify installation:

   which breakdown
   

2. Test with direct execution:

   deno run --allow-all jsr:@tettuan/breakdown
   

3. Compile as binary:

   deno compile -A -o ~/.deno/bin/breakdown jsr:@tettuan/breakdown
   

4. Check PATH:

   echo $PATH
   

Basic Commands

Initialize Working Directory

breakdown init

This command creates the necessary working directory structure as specified in the configuration.

Markdown Processing Commands

The following combinations are available:

Command \ Layer	Command Description	Project	Issue	Task
to	Command to convert input Markdown to the next layer format	Break down to project breakdown to project -o=	Break down from project to issue breakdown to issue <project_summary.md|written_issue.md> -o=	Break down from issue to task breakdown to task <issue.md|written_task.md> -o=
summary	Command to generate new Markdown or generate Markdown for specified layer	Generate project summary in Markdown format echo “" | breakdown summary project -o=	Generate issue summary in Markdown format breakdown summary issue –from= --input=task -o=	Generate task summary in Markdown format breakdown summary task –from= -o=
defect	Command to generate fixes from error logs or defect information	Generate project information from defect information tail -100 “" | breakdown defect project -o=	Generate issues from defect information breakdown defect issue –from= -o=	Generate tasks from defect information breakdown defect task –from= -o=

Break Down to Project

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

Break Down to Issue

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

Break Down to Task

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

Generate Markdown Summary

Project Summary Generate project overview from unorganized information:

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

Issue Summary Generate issues from task groups:

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

Task Summary Generate organized tasks from unorganized task information:

breakdown summary task --from=<unorganized_tasks.md> -o=<task_markdown_dir>

This site is open source. Improve this page.