<CRITICAL_INSTRUCTION>
BACKLOG WORKFLOW INSTRUCTIONS
This project uses Backlog.md MCP for all task and project management.
CRITICAL RESOURCE: Read backlog://workflow/overview to understand when and how to use Backlog for this project.
- First time working here? Read the overview resource IMMEDIATELY to learn the workflow
- Already familiar? You should have the overview cached ("## Backlog.md Overview (MCP)")
- When to read it: BEFORE creating tasks, or when you're unsure whether to track work
The overview resource contains:
- Decision framework for when to create tasks
- Search-first workflow to avoid duplicates
- Links to detailed guides for task creation, execution, and completion
- MCP tools reference
You MUST read the overview resource to understand the complete workflow. The information is NOT summarized here.
</CRITICAL_INSTRUCTION>
Commands
Development
bun i- Install dependenciesbun test- Run testsbun run format- Format code with Biomebun run lint- Lint and auto-fix with Biomebun run check- Run all Biome checks (format + lint)bun run build- Build the CLI toolbun run cli- Uses the CLI tool directly
Testing
bun test- Run all testsbun test <filename>- Run specific test file
Configuration Management
bun run cli config list- View all configuration valuesbun run cli config get <key>- Get a specific config value (e.g. defaultEditor)bun run cli config set <key> <value>- Set a config value with validation
Core Structure
- CLI Tool: Built with Bun and TypeScript as a global npm package (
npm i -g backlog.md) - Source Code: Located in
/srcdirectory with modular TypeScript structure - Task Management: Uses markdown files in
backlog/directory structure - Workflow: Git-integrated with task IDs referenced in commits and PRs
Code Standards
- Runtime: Bun with TypeScript 5
- Formatting: Biome with tab indentation and double quotes
- Linting: Biome recommended rules
- Testing: Bun's built-in test runner
- Pre-commit: Husky + lint-staged automatically runs Biome checks before commits
The pre-commit hook automatically runs biome check --write on staged files to ensure code quality. If linting errors
are found, the commit will be blocked until fixed.
Git Workflow
- Branching: Use feature branches when working on tasks (e.g.
tasks/task-123-feature-name) - Committing: Use the following format:
TASK-123 - Title of the task - Github CLI: Use
ghwhenever possible for PRs and issues