Command reference - imdone docs

Commands

📋 Output Formats: Many commands support the -f, --format option to change output format. Available formats are: json, yaml, csv, text (default).

Command index

init - Initialize Issue Tracking Integration
clone - Clone Remote Backlog Repository
update - Update imdone-cli Config
docs - Open imdone-cli Docs
current - Show Or Set The Current Story
ai - Launch A Coding Agent With Story Context
hdd - Launch A Coding Agent With HDD Context
note - Record A Local Issue Progress Note
pull - Pull Issues from Provider
push - Push Changes to Provider
status - Show Pending Changes
add - Create New Issue
template - Apply Template to Existing Issue
merge - Resolve Conflicts
move - Move Issue to New Status
lint - Lint Todo Comments
reset - Reset Local Project State
clean - Clean Project Data
destroy - Remove Integration
license - Manage License
show - Show Local Issue Context
list - List Local Issues
favorite - Mark Issues as Favorites
log - View Issue Changelog
test - Test Configuration
pause - Pause Desktop Watcher
resume - Resume Desktop Watcher
hooks - Git Hooks Management

`init` – Initialize Issue Tracking Integration

imdone init

Initialize integration with Jira or GitHub Issues. You’ll be prompted to select your provider and provide the necessary configuration.

Common Options:

--name - Project name
--provider - Issue tracking provider: jira or github
--force - Force initialization even if .imdone-cli.yml exists in an ancestor directory

Jira Options:

--jira-url - Jira instance URL
--jira-project-key - Jira project key
--jira-username - Jira username
--jira-api-token - Jira API token
--jql - JQL query for filtering issues

Jira Notes:

Enterprise or self-hosted Jira instances that use Personal Access Tokens with Bearer auth should set JIRA_AUTH_BASIC=false in the backlog .env file.
Jira-backed configs require issueType under settings.plugins.JiraPlugin; use the exact Jira issue type name such as Story, Task, or Bug.
Generated configs write JQL as a YAML block scalar. If you hand-edit .imdone/config.yml, use jql: |- for queries with quotes, colons, or other punctuation.

GitHub Options:

--github-url - GitHub Enterprise URL (for example, https://github.mycompany.com)
--github-owner - GitHub repository owner (auto-detected from git remote when in a git repo)
--github-repo - GitHub repository name (auto-detected from git remote when in a git repo)
--github-token - GitHub Personal Access Token
--gql - GitHub issue query (for example, is:issue state:open)

GitHub Notes:

imdone pull fetches issues, comments, and attachments from GitHub
imdone push syncs issue content, labels, comments, and attachments (add/modify/delete/rename)
imdone add fully supports creating GitHub issues
GitHub owner and repo are auto-detected from your git remote origin URL
During imdone init, the GitHub repository prompt accepts HTTPS and Git-style SSH repository inputs such as https://github.com/owner/repo, git@github.com:owner/repo.git, ssh://git@github.com/owner/repo.git, and git+ssh://git@github.com/owner/repo.git
The GitHub repository prompt now shows accepted repository examples directly in the prompt, and invalid input repeats those examples in the validation message
Token guidance: classic tokens need repo; fine-grained tokens need repository Contents: Read and write, Issues: Read and write, and Pull requests: Read and write

`clone` – Clone Remote Backlog Repository

imdone clone

Options:

--remote-url
--backlog-dir
--github-owner
--github-repo
--github-token

Clones a remote backlog repo for onboarding or setting up a new local workspace. After the backlog is cloned locally, imdone clone reads the cloned config and prompts only for any missing provider-specific setup values that are still needed, such as GitHub owner, repo, or token.

If the cloned .imdone-cli.yml is already configured for GitHub, imdone clone now preserves that provider instead of falling back to Jira prompts. GitHub-backed clones only ask for missing owner, repo, and token values after clone. Existing cloned config values and CLI flags suppress redundant prompts, and gql stays in the cloned config rather than being re-prompted.

`update` – Update imdone-cli Config

imdone update
imdone update --format json

Alias: u

Refresh bundled imdone project files such as docs, skills, templates, and local support files. The command reports the file paths it changed, or reports that no bundled files changed. Run imdone pull separately when you want to sync Jira or GitHub issues.

Options:

--force - Force the update without prompting when imdone-cli is outdated
--skip-merge - Skip merging from main and only copy bundled files
-f, --format <format> - Output format: json, yaml, text

`docs` – Open imdone-cli Docs

imdone docs

Opens the public imdone-cli docs page in your default browser:

https://imdone.io/imdone-cli

`current` – Show Or Set The Current Story

imdone current
imdone current PROJ-123

Shows the active story stored in backlog/.imdone/agent-config.yml, including the story key and title. Use this before recording progress notes when you want to confirm which story imdone-backed agent workflows consider current.

With an issue key, imdone current <issueKey> validates that the issue exists locally before changing the active story. If no story is active, the stored story is stale, or the requested issue is not available locally, the command exits non-zero and tells you how to recover.

imdone current is the workflow-friendly way to inspect or change active-story context. Use imdone agent-config only when you need the lower-level JSON configuration surface.

`ai` – Launch A Coding Agent With Story Context

imdone ai [issueKey]
imdone ai --setup

Launch Codex or Claude with lightweight story context. Use this when you want an agent to read the local issue, comments, attachments, and progress notes, then wait for your next instruction without starting the full HDD workflow.

By default, imdone ai:

uses the explicit issueKey argument when provided
otherwise prompts for a story key, with the active story from backlog/.imdone/agent-config.yml preselected when available
does not change the active story in backlog/.imdone/agent-config.yml
reuses the saved default coding agent when available
falls back to a pasteable story-context prompt when no supported coding agent is installed

Launch output shows the configured active story and points to imdone current <issueKey> when you need to correct story context before progress notes are recorded.

Use --setup to force reselecting both the story key and coding agent instead of reusing the saved lightweight AI launch context.

Options:

-s, --setup - Force issue-key and agent setup before launch

The prompt tells the agent to wait for user instructions before assuming it should do more than read context, and to use imdone note for decisions, blockers, corrections, completed work, evidence, and next steps. Use imdone hdd when you want the full Hypothesis-Driven Development session contract.

`hdd` – Launch A Coding Agent With HDD Context

imdone hdd [issueKey]
imdone hdd --setup

Launch Codex or Claude with a startup prompt that tells the agent to use the bundled hypothesis-driven-development skill for the resolved story.

By default, imdone hdd:

uses the explicit issueKey argument when provided
otherwise reuses the active HDD story from backlog/.imdone/agent-config.yml
otherwise prompts for a story key
reuses the saved default coding agent when available
falls back to a pasteable HDD prompt when no supported coding agent is installed

Use --setup to force reselecting both the story key and coding agent instead of reusing the saved HDD launch context.

Options:

-s, --setup - Force issue-key and agent setup before launch

`note` – Record A Local Issue Progress Note

imdone note PROJ-123 "Changed the implementation path after the failing test exposed a missing fallback"
imdone note PROJ-123 "Override path test" --file /tmp/progress-notes.md
imdone note PROJ-123 "SAFE_EXAMPLE=value" --allow-env SAFE_EXAMPLE

Appends a timestamped progress note for an issue. By default, notes are written to the issue’s attachments/progress-notes.md file and the issue body is linked to that attachment when needed.

imdone note blocks obvious credential assignments and environment-variable dumps before writing progress notes. Do not paste environment variables or their values into note text unless the value is safe to persist and the variable name is explicitly allowlisted with --allow-env <name> or comma-separated names.

Each note includes:

a full ISO timestamp with timezone offset
the local git author when available
a fallback author when git identity is unavailable
the note text

For evidence-bearing notebook entries, prefer this four-line shape:

Observation: <what I saw>
Evidence: <test count / captured response / command output / commit>
Decision: <what we're doing about it, and why over the alternative>
Next: <what the next person should do / trust>

imdone note is local-only. It does not push to Jira or GitHub by itself; run imdone push when you are ready to sync the note attachment and issue-file link to your provider.

Use --file <path> to append the note to a specific file instead of the issue’s default progress-notes attachment.

Use --allow-env <names> only for specific variables that are safe to persist. The command reports when allowlisted environment variable content was recorded without echoing the note value back to the terminal.

`pull` – Pull Issues from Provider

imdone pull
imdone pull SCRUM-375
imdone pull 123

Alias: g

Options:

-f, --format <format> - Output format: json, yaml, csv, text (default: text)
--jql [jql] - Jira only. Temporarily override the saved Jira query for this pull run only
--gql [gql] - GitHub only. Temporarily override the saved GitHub query for this pull run only
--no-git - Skip git coordination for this pull run while still refreshing provider issues

Fetches issues, comments, and attachments from your configured provider, updates the local Markdown workspace, and restores local changes when needed.

Use imdone pull <issue-key> when you only need to refresh one known issue. Jira-style keys such as SCRUM-375 target Jira, and numeric ids such as 123 target GitHub. This is the shortest single-issue pull form; use --jql or --gql when you need an explicit provider-specific query override.

Use imdone pull --no-git when you only need provider state refreshed and cannot rely on a git repository or git-safe working tree for that operation. This still runs provider configuration checks, provider refresh, project refresh, and empty-directory cleanup, but it skips branch safety, local-change detection, stashing, clean-worktree checks, git commits, stash-pop, and merge-conflict checks. The command output warns that local changes were not protected by git and includes a feedback link for pull-only problems.

For headless automation such as CI, containers, or Lambda jobs that only read provider issues, install imdone-cli from npm and run imdone pull --no-git. When no anonymous data-capture preference is saved and the process has no TTY, imdone defaults to no anonymous capture instead of prompting. Because --no-git opts out of local-change protection, use it in a disposable workspace or make sure no local issue edits need to be preserved by imdone’s git coordination.

For Jira-backed projects, you can use --jql to temporarily broaden or change the pull scope for one run without editing .imdone/config.yml. This is useful for backlog refinement when you want to pull a wider set of issues and then return to your normal default sync scope on the next plain imdone pull.

For GitHub-backed projects, you can use --gql to temporarily target a specific GitHub issue or pull-request slice for one run without changing the saved default GitHub query.

If the project is configured with both Jira and GitHub providers:

--jql affects only the Jira provider for that run
--gql affects only the GitHub provider for that run
you can use both in the same imdone pull command

What gets pulled:

Issue content and metadata
All comments (see Working with Comments)
All attachments (see Working with Attachments)
Status and field updates

Provider Notes:

GitHub:

Fetches issues based on state (open/closed), labels, milestones, and assignees
Maps GitHub states to imdone lists via status configuration
Handles pagination automatically for large repositories
Attachments are downloaded from the dedicated imdone-attachments branch and linked locally
When an issue is newly pulled and already maps to the done list, it is created directly in the archive folder if archive is configured

Jira:

Uses JQL queries for flexible filtering
Sprint and epic integration
imdone pull --jql "<query>" temporarily replaces the saved Jira query for that run only, while still refreshing already-synced local Jira issues
In mixed Jira/GitHub projects, --jql affects only the Jira provider’s pull for that run
When an issue is newly pulled and already maps to the done list, it is created directly in the archive folder if archive is configured

GitHub query override examples:

# Refresh one GitHub issue by number
imdone pull 123

# Temporarily target one GitHub slice
imdone pull --gql 'is:pr state:open'

# Temporarily override both providers in the same run
imdone pull --jql 'project = "SCRUM" AND status != Done ORDER BY updated DESC' --gql 'is:pr state:open'

# Refresh provider issue files without git coordination
imdone pull --no-git

Jira issue examples:

# Refresh one Jira issue by key
imdone pull SCRUM-375

`push` – Push Changes to Provider

imdone push
imdone push PROJ-123

Alias: p

Pass an issue key or number to push one issue only. For example, imdone push SCRUM-335 syncs that issue and leaves unrelated local issue changes in your working tree.

Options:

--rewrite-repo-links - GitHub only. For touched issues, republish in-scope issue content and text attachments so local repo-relative markdown links are refreshed against the current source-repo web-link mapping

Lints, pulls, extracts updates, and syncs your local Markdown changes back to the provider. A plain imdone push processes pending provider-backed issue changes. imdone push <issueKey> scopes the pull, provider write, and local git commit to that issue.

What gets pushed:

Issue content and metadata changes
New comments (see Working with Comments)
New and modified attachments (see Working with Attachments)
Labels
Provider workflow state when the issue’s local imdone list has an explicit status mapping

Provider Notes:

Jira:

Validates markdown formatting for Jira compatibility
Converts markdown to Jira markup automatically
Applies mapped local-list changes as Jira workflow transitions when .imdone/config.yml has a matching statuses[*].list and statuses[*].jira entry

GitHub:

Uses markdown natively (no conversion needed)
Applies mapped local-list changes by using native open/closed state mappings or configured GitHub status labels/tags
Attachments are uploaded to the dedicated imdone-attachments branch; local links are rewritten to the current attachment URL
imdone push --rewrite-repo-links explicitly refreshes in-scope repo-relative markdown links in touched GitHub issue content and text attachments against the current source-repo web-link mapping, even when the touched content would not otherwise need republishing
GitHub attachment add, modify, delete, and rename operations update the branch-backed current set without writing an attachment ledger comment

💡 Pro Tip: Use commentRequired:true in task metadata to enforce comments on critical issues before pushing.

`status` – Show Pending Changes

imdone status

Alias: st

Shows local file changes across the backlog repo. Backlog issue files are grouped by issue context, and other files in the backlog repo appear under Other changes.

Output:

Changes (5 files):

In current-sprint (4 files):
  Added:
    attachment  SCRUM-200    current-sprint/SCRUM-200-New_plan/attachments/new-plan.md

  Modified:
    task        SCRUM-123    current-sprint/SCRUM-123-Example/issue-SCRUM-123.md
    comment     SCRUM-123    current-sprint/SCRUM-123-Example/comments-SCRUM-123.md

  Deleted:
    attachment  SCRUM-456    current-sprint/SCRUM-456-Screenshot/attachments/screenshot.png

Other changes (1 file):
  Modified:
    README.md

Backlog issue lines show the kind (task, comment, or attachment), the issue key, and the cwd-relative path. Other local changes also show cwd-relative file paths. If the working directory is clean, it prints Working directory is clean.

`add` – Create New Issue

imdone add

Alias: a

Creates a new Jira or GitHub issue either interactively or from provided options. The prompts adapt to the selected provider. After the new issue is pulled locally, text output includes the issue file path relative to the cwd where imdone add was run.

Options:

--provider [provider] - Provider to create the issue in (jira or github)
--project-key [projectKey] - Project key (e.g., PROJ for Jira, owner/repo for GitHub)
--template [template] - Template to use for the issue (e.g., story, bug)
--issue-type [issueType] - Issue type (Jira only: Story, Task, Bug, etc.)
--location [location] - Issue location (Jira only): “backlog” or “sprint”
--sprint-id [sprintId] - Sprint ID when location is “sprint” (Jira only)
--list-sprints - Jira only. List active sprint names and IDs that can be used with --sprint-id, then exit without creating an issue
--list-issue-types - Jira only. List available issue types that can be used with --issue-type, then exit without creating an issue
--summary [summary] - Issue summary/title
-f, --format <format> - Output format: json, yaml, csv, text (default: text)

Examples:

# Jira: Discover valid sprint IDs first
imdone add --project-key PROJ --list-sprints

# Jira: Discover valid issue types first
imdone add --project-key PROJ --list-issue-types

# Jira: Create issue with all options specified
imdone add --project-key PROJ --template story --issue-type Story --location sprint --sprint-id 123 --summary "New feature request"

# GitHub: Create issue (note: no issue-type or location needed)
imdone add --project-key owner/repo --template story --summary "Bug fix request"

# Interactive mode for any provider
imdone add

Interactive prompts (when options not provided):

Template selection - Choose from available templates in .imdone/templates
Project selection - Choose which project to create the issue in (only shown when multiple projects are configured)
Issue type - Select issue type (Jira only - skipped for GitHub)
Location - Choose current sprint or backlog (Jira only - skipped for GitHub)
Summary - Enter the issue title/summary

Sprint discovery: If you want to script issue creation into a specific Jira sprint, run imdone add --list-sprints first. It prints the active sprint names and IDs for the selected Jira project, so you can copy the correct value into --sprint-id without opening Jira.

Issue type discovery: If you want to script issue creation with an exact Jira issue type, run imdone add --list-issue-types first. It prints the available issue types for the selected Jira project, so you can pass the exact value into --issue-type without guessing.

What gets created:

New issue in your provider (Jira or GitHub) with specified summary
Markdown content based on selected template (if any)
Basic structure (Description, Tasks) if no template is used
Template tags automatically converted to labels (GitHub) or labels field (Jira)
A provider-specific replay command showing how to create similar issues without prompts
Automatic pull of the new issue into your local project
Cwd-relative issue file output so you can open the new local Markdown file from the same terminal location
When a template is selected, follow-up template files, provider updates, and local commits are scoped to the new issue so other local issue edits remain untouched

Templates: If your project has templates in .imdone/templates, they are available during issue creation. Templates give you consistent starting structure, and tags in templates (for example #bug or #urgent) are automatically converted to labels.

Templates can also include special links that automatically create files in the issue’s attachments/ directory. See the Auto-File Creation in Templates section under the template command for details.

💡 Replay Command: After creating an issue, the CLI will display the exact command to create a similar issue without prompts, tailored to your provider:

Jira example:

💡 Next time, use: imdone add --project-key "PROJ" --template "story" --issue-type "Story" --location "backlog" --summary "Your issue title"

GitHub example:

💡 Next time, use: imdone add --project-key "owner/repo" --template "story" --summary "Your issue title"

`template` – Apply Template to Existing Issue

imdone template [issueKey]

Alias: t

Applies a template to an existing issue through an interactive guided flow or with explicit options.

Arguments:

[issueKey] - Issue key to apply template to (e.g., PROJ-123)

Options:

--template [template] - Template to apply (e.g., story, bug, dod)

Examples:

# Apply template with all options specified
imdone template PROJ-123 --template dod

# Interactive mode - prompts for missing arguments
imdone template

# Prompt for template only
imdone template PROJ-123

Interactive prompts (when options not provided):

Issue selection - Choose from available issues in current sprint
Template selection - Choose from available templates in .imdone/templates

What gets applied:

Template metadata (tags, custom fields) is merged with existing metadata
Provider refresh and push are scoped to the target issue. If the issue was just refreshed in the same command, imdone template skips a redundant second pull before pushing the template update.

Templates: Templates are markdown files in .imdone/templates that provide consistent issue structure. Templates can reference existing issue content with ${markdown} to keep current content in place. A default story template is included.

Auto-File Creation in Templates: Templates can automatically create files in the issue’s attachments directory using specially formatted links. This works with both imdone add (when creating new issues) and imdone template (when applying templates to existing issues).

[Link Text](./attachments/filename.ext?template=<template_name>)
[Empty File](./attachments/filename.ext)

Links with ?template=<template_name> create files populated with content from the specified template
- Template names can be specified with or without the template_ prefix (e.g., story or template_story)
Links without a template parameter create empty files
Files are created in the issue’s attachments/ directory when the template is used
Existing files are never overwritten
If a template is not found, an empty file is created with a warning

Example Template with Auto-File Creation:

# Story Template

## Documents
- [Story Document](./attachments/story.md?template=story)
- [Notes](./attachments/notes.md)
- [Test Plan](./attachments/test-plan.md?template=test)

## Description
Add your story description here...

When this template is used (either with imdone add or imdone template), the system will automatically:

Create the attachments/ directory in the issue folder
Create story.md with content from the story template
Create an empty notes.md file
Create test-plan.md with content from the test template

`merge` – Resolve Conflicts

imdone merge

After resolving conflicts manually, run this to push the resolved changes to your configured provider.

`move` – Move Issue to New Status

imdone move [<ISSUE_KEY>] [<STATUS>]

Alias: mv

Moves a Jira or GitHub issue to a new status by performing the provider-specific status change. If arguments are not provided, the command will prompt for them interactively.

When moving an issue to “Done” status, the resolution field can be set automatically or interactively.

Arguments:

ISSUE_KEY - The issue identifier (for example, Jira PROJ-123 or a GitHub issue number)
STATUS - The target status name (case-insensitive)

Options:

-f, --format <format> - Output format: json, yaml, csv, text (default: text)
-r, --resolution <resolution> - Set custom resolution when moving to Done (e.g., “Fixed”, “Won’t Do”)
--no-resolution - Skip setting resolution even when moving to Done
-p, --prompt-resolution - Interactively select resolution from available options
--list-statuses - List valid statuses for the issue without changing it
--list-transitions - Alias for --list-statuses

Resolution Behavior:

By default, moving to “Done” automatically sets resolution to “Done”
Existing resolutions are never overwritten
Use --prompt-resolution to see all available resolutions and choose interactively
Use --no-resolution to skip resolution setting entirely

Examples:

# Move issue with specified arguments (auto-sets resolution to "Done")
imdone move PROJ-123 "Done"

# Move issue with custom resolution
imdone move PROJ-123 "Done" --resolution "Fixed"

# Interactive resolution selection
imdone move PROJ-123 "Done" --prompt-resolution

# Move to Done without setting resolution
imdone move PROJ-123 "Done" --no-resolution

# Move issue and output in JSON format
imdone move PROJ-123 "In Progress" --format json

# List valid statuses without changing the issue
imdone move PROJ-123 --list-statuses

# List valid statuses in structured output
imdone move PROJ-123 --list-statuses --format json

# Interactive mode - prompts for missing arguments
imdone move

# Prompt for status only
imdone move PROJ-123

The command automatically discovers available transitions for the issue and provides an interactive selection if the specified status is not valid. Use --list-statuses or --list-transitions when you want that discovery step without mutating the issue.

`lint` – Lint Todo Comments

imdone lint

Checks and fixes formatting issues for compatibility with Jira.

`reset` – Reset Local Project State

imdone reset

Options:

-f, --format <format> - Output format: json, yaml, csv, text (default: text)

Removes Jira integration state and pulls fresh data from Jira.

`clean` – Clean Project Data

imdone clean

Removes temporary files and data from the project without affecting the core configuration.

`destroy` – Remove Integration

imdone destroy

Deletes the config and backlog folder. Prompts for confirmation first.

`license` – Manage License

imdone license

Options:

--token
-s, --show

Examples:

imdone license --token <your-token>
imdone license --show
imdone license -s

`show` – Show Local Issue Context

imdone show [ISSUE_KEY]

Alias: s

Shows the local shared context for one issue from your backlog repo. The default text output includes the issue title, status, tags, metadata, cwd-relative paths for the issue and comments files, the attachments directory, and visible attachment filenames. If no issue key is provided, you’ll be prompted to search and select from existing issues.

Options:

-f, --format <format> - Output format: json, yaml, csv, text (default: text)

Structured output:

json and yaml include the local issue-context fields for automation, including key, title, status, tags, meta, issueFile, commentsFile, attachmentsDir, and attachments
csv flattens the same fields for shell and spreadsheet workflows

Notes:

Paths are relative to the cwd where the command was run, not absolute
Missing comments or attachments are shown explicitly as none in text output and null / empty arrays in structured output

Examples:

# Interactive mode - search and select issue
imdone show

# Default text format - local shared context
imdone show PROJ-123

# Text format (explicit)
imdone show PROJ-123 --format text
imdone show PROJ-123 -f text

# JSON format - structured data for automation
imdone show PROJ-123 --format json

# YAML format - preserves Jira markup and metadata
imdone show PROJ-123 --format yaml

# CSV format - tabular data
imdone show PROJ-123 --format csv

# Interactive mode with different format
imdone show --format json

`list` – List Local Issues

imdone list

Alias: ls

Lists all issues from your configured provider (Jira or GitHub). Uses Unix ls-style flags for familiar terminal behavior. Issue paths are shown relative to the cwd where the command was run.

Display Options:

-l - Long format with detailed issue information (status, assignee, type)
-1 - One issue per line (compact: KEY + PATH)
-t - Sort by modification time (most recent first)
-r - Reverse sort order
Default format shows compact listing (KEY + cwd-relative PATH per line)
Favorited issues show a ★ indicator in all views

Filter and Output Options:

--fav, --favorites - Show only favorited issues (see imdone favorite)
--limit <number> - Limit the number of tasks displayed (default: 0, no limit)
-f, --format <format> - Output format: json, yaml, csv, text (default: text)
-q, --query <query> - Filter issues using imdone filter syntax (applied locally)

Examples:

# Compact listing (default) - shows KEY and PATH
imdone list

# Long format with details (table view)
imdone ls -l

# Sort by time, most recent first
imdone ls -t

# Long format, sorted by time
imdone ls -lt

# Reverse the sort order (oldest first)
imdone ls -ltr

# One issue per line (same as default compact format)
imdone ls -1

# Limit to 10 most recent issues
imdone list -t --limit 10

# Show only favorited issues
imdone list --favorites
imdone ls --fav

# Favorites in long format, sorted by time
imdone ls --fav -lt

# List issues in JSON format
imdone list --format json

# List limited issues in CSV format
imdone list --limit 5 --format csv

# Filter by status
imdone ls -q 'meta.status="In Progress"'

# Filter by assignee
imdone ls -q 'meta.assignedTo="username"'

# Filter by label/tag
imdone ls -q 'tag:bug'

# Filter open issues
imdone ls -q 'meta.status="open"'

# Filter by milestone
imdone ls -q 'meta.milestone="v1.0"'

# Filter blocked issues (Jira)
imdone ls -q 'meta.blocked=*'

# Combine filters
imdone ls -q 'meta.status="open" and tag:enhancement'

# Filter pull requests (GitHub)
imdone ls -q 'meta.isPullRequest=true'

imdone Filter Syntax:

The -q, --query option uses imdone’s filter syntax, applied locally against your synced issues. This single query language works across all providers (Jira, GitHub).

Learn more about imdone filter syntax

Common filter patterns:

meta.status="In Progress" - Filter by status value
meta.assignedTo="username" - Filter by assignee
meta.milestone="v1.0" - Filter by milestone (GitHub)
meta.blocked=* - Show blocked/flagged issues (Jira)
tag:bug - Filter by tag/label
meta.isPullRequest=true - Show only pull requests (GitHub)
meta.status="open" tag:enhancement - Combine multiple filters

`favorite` – Mark Issues as Favorites

imdone favorite [ISSUE_KEY]

Alias: f

Mark issues as favorites for quick access when working with many issues in your current sprint. Favorites are stored locally in .imdone/favorites.yml and are personal to your workspace.

Arguments:

[ISSUE_KEY] - Issue key to favorite (e.g., PROJ-123 for Jira, 42 for GitHub)

Options:

-r, --remove - Remove issue from favorites

Examples:

# Mark issue as favorite
imdone favorite PROJ-123

# Interactive mode - search and select from available issues
imdone favorite

# Remove issue from favorites
imdone favorite PROJ-123 --remove
imdone favorite PROJ-123 -r

# Interactive removal - search and select from favorited issues only
imdone favorite --remove

# List only your favorite issues
imdone ls --favorites
imdone ls --fav

# Combine with other ls flags
imdone ls --fav -l      # Long format, favorites only
imdone ls --fav -t      # Favorites sorted by time

How it works:

Mark as favorite: Validates the issue exists in your current sprint and adds it to your favorites list
Visual indicator: Favorited issues show a ★ indicator in all list views
Filter favorites: Use imdone ls --favorites to see only your favorited issues
Personal workspace: Favorites are stored in .imdone/favorites.yml (git-ignored) and don’t sync across team members

When to use:

Working on 2-3 specific issues among many in current sprint
Quickly filtering to your most important work items
Reducing navigation overhead in large sprints

Provider Support:

Jira: Use project keys like PROJ-123
GitHub: Use issue numbers like 42

`log` – View Issue Changelog

imdone log [<ISSUE_KEY>] [--stats]

Shows changelog for a Jira or GitHub issue, with optional statistics. If no issue key is provided, you’ll be prompted to search and select from existing issues. In mixed-provider projects, the selected or supplied issue key is resolved against local issue metadata so the changelog request is sent to the correct provider adapter.

Arguments:

ISSUE_KEY - The issue identifier (optional). Use Jira keys like PROJ-123 or GitHub issue numbers like 42.

Options:

-s, --stats - Show statistics for the changelog
-f, --format <format> - Output format: json, yaml, csv, text (default: text)

Examples:

# Show changelog for specific issue
imdone log PROJ-123

# Show changelog for a GitHub issue
imdone log 42

# Show changelog statistics for specific issue  
imdone log PROJ-123 --stats

# Show changelog in JSON format
imdone log PROJ-123 --format json

# Show changelog statistics in YAML format
imdone log PROJ-123 --stats --format yaml

# Interactive mode - search and select issue
imdone log

# Interactive mode with statistics
imdone log --stats

`test` – Test Configuration

imdone test

Validates connection and permission setup.

`pause` – Pause Desktop Watcher

imdone pause

Pauses the imdone desktop watcher by creating a .imdonepause file in the backlog directory. This prevents conflicts between CLI operations and the desktop application.

When to use:

Before running extended CLI operations
When you want to prevent desktop automatic syncing temporarily
During manual conflict resolution

Note: All imdone-cli commands automatically pause the watcher during execution and resume when complete.

`resume` – Resume Desktop Watcher

imdone resume

Resumes the imdone desktop watcher by removing the .imdonepause file from the backlog directory.

When to use:

After manually pausing the watcher
If a CLI command was interrupted and didn’t resume automatically

`hooks` – Git Hooks Management

Set up automatic `imdone pull` after `git pull` and `imdone push` before `git push`

imdone hooks setup

Options:

--force - Overwrite existing git hooks

This sets up git hooks that automatically synchronize your configured provider with git operations:

post-merge hook: Runs imdone pull after each successful git pull to fetch the latest provider issues
pre-push hook: Runs imdone push before each git push to ensure your local issue changes are synchronized

Remove git hooks

imdone hooks remove

Removes git hooks that were set up by imdone-cli.

How it works:

Creates post-merge and pre-push hooks in .git/hooks/
The hooks detect if the current directory has imdone configuration
post-merge: Automatically runs imdone pull after successful git merges (which happen during git pull)
pre-push: Automatically runs imdone push before git push operations
The pre-push hook will cancel the push if imdone push fails (use git push --no-verify to bypass)
Only runs for actual merges, not rebases
Gracefully handles cases where imdone-cli is not available

Commands

Command index

init – Initialize Issue Tracking Integration

clone – Clone Remote Backlog Repository

update – Update imdone-cli Config

docs – Open imdone-cli Docs

current – Show Or Set The Current Story

ai – Launch A Coding Agent With Story Context

hdd – Launch A Coding Agent With HDD Context

note – Record A Local Issue Progress Note

pull – Pull Issues from Provider

push – Push Changes to Provider

status – Show Pending Changes

add – Create New Issue

template – Apply Template to Existing Issue

merge – Resolve Conflicts

move – Move Issue to New Status

lint – Lint Todo Comments

reset – Reset Local Project State

clean – Clean Project Data

destroy – Remove Integration

license – Manage License

show – Show Local Issue Context

list – List Local Issues

favorite – Mark Issues as Favorites

log – View Issue Changelog

test – Test Configuration

pause – Pause Desktop Watcher

resume – Resume Desktop Watcher

hooks – Git Hooks Management

Set up automatic imdone pull after git pull and imdone push before git push

Remove git hooks

`init` – Initialize Issue Tracking Integration

`clone` – Clone Remote Backlog Repository

`update` – Update imdone-cli Config

`docs` – Open imdone-cli Docs

`current` – Show Or Set The Current Story

`ai` – Launch A Coding Agent With Story Context

`hdd` – Launch A Coding Agent With HDD Context

`note` – Record A Local Issue Progress Note

`pull` – Pull Issues from Provider

`push` – Push Changes to Provider

`status` – Show Pending Changes

`add` – Create New Issue

`template` – Apply Template to Existing Issue

`merge` – Resolve Conflicts

`move` – Move Issue to New Status

`lint` – Lint Todo Comments

`reset` – Reset Local Project State

`clean` – Clean Project Data

`destroy` – Remove Integration

`license` – Manage License

`show` – Show Local Issue Context

`list` – List Local Issues

`favorite` – Mark Issues as Favorites

`log` – View Issue Changelog

`test` – Test Configuration

`pause` – Pause Desktop Watcher

`resume` – Resume Desktop Watcher

`hooks` – Git Hooks Management

Set up automatic `imdone pull` after `git pull` and `imdone push` before `git push`