imdone-cli docs

Install and initialize

Install imdone-cli, run imdone init, and configure provider access.

Get Started

Start with one local setup path. Install the published imdone-cli package, then run imdone init from the project where you want issue context to live.

# 1) Install
npm i -g imdone-cli

# 2) Initialize and sync issues
imdone init

# 3) Open stories in your editor (Markdown next to your code)
code . # nvim .

What you’ll see: A backlog/current-sprint/ directory with one folder per issue. Each issue folder contains the main issue content, comments, lifecycle history in changelog.yml, and an attachments/ folder. Edit Markdown locally; imdone push syncs changes back to Jira or GitHub so the issue becomes the shared working memory for the next build-measure-learn loop.

The same synced issues can also be monitored visually on the imdone kanban board.

You can try imdone-cli without creating an account. Anonymous CLI users get 50 provider syncs on their device, then 10 provider syncs per month forever on that same device. A provider sync is a command that writes changes back to Jira or GitHub, such as imdone push, imdone add, or imdone move; reading and local discovery commands such as imdone pull, imdone ls, and imdone show do not use that allowance.

backlog/
├── .imdone/
│   ├── config.yml
│   └── templates/
│       └── story.md
├── current-sprint/
│   ├── PROJ-123-Fix_login_bug/
│   │   ├── attachments/
│   │   │   └── error-screenshot.png
│   │   ├── changelog.yml
│   │   ├── comments-PROJ-123.md
│   │   └── issue-PROJ-123.md
│   └── PROJ-124-Add_user_dashboard/
│       ├── attachments/
│       ├── changelog.yml
│       ├── comments-PROJ-124.md
│       └── issue-PROJ-124.md

1Password-Managed Credentials

imdone now supports direct 1Password-backed credentials without a wrapper script.

Recommended flow from your software project root:

imdone init --1password
imdone ls
imdone push

Requirements:

  • 1Password CLI: brew install 1password-cli
  • A signed-in 1Password account: op signin

What the direct integration does:

  • Stores Jira and GitHub credentials in 1Password and replaces plain backlog .env secrets with op://... references.
  • Resolves those op://... references automatically when you run imdone directly.
  • Prompts you to migrate when op is available but the repo is still using plain provider secrets in .env.

By default, migration writes items to the Employee vault. Set IMDONE_1PASSWORD_VAULT to target a different vault before running setup:

IMDONE_1PASSWORD_VAULT=Private imdone init --1password