From f002922ab864c93cc5839745f5e090f50bf8fcc0 Mon Sep 17 00:00:00 2001 From: Tiara Rodney Date: Sun, 22 Mar 2026 01:42:32 +0100 Subject: [PATCH] fix: replace todo with mime-todo in all CLI references --- AGENTS.md | 26 +++++++++++++------------- src/README.rst | 42 +++++++++++++++++++++--------------------- 2 files changed, 34 insertions(+), 34 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 70b8f66..6cd1696 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -50,35 +50,35 @@ transition commits manually. ```sh # Create an issue (must be on develop) -todo create --type feature --title "Title" --plan "Description" +mime-todo create --type feature --title "Title" --plan "Description" # Start work (must be on develop) -todo start --acceptance-criteria "What must be true for this to be done" +mime-todo start --acceptance-criteria "What must be true for this to be done" # Then create the branch: git checkout -b / # Complete work (must be on /) -todo done --acceptance "What was delivered against the criteria" +mime-todo done --acceptance "What was delivered against the criteria" # Hold or cancel -todo hold --reason "Why" -todo cancel --reason "Why" +mime-todo hold --reason "Why" +mime-todo cancel --reason "Why" ``` ### Querying ```sh -todo list # list all issues -todo show # show issue details -todo sprints # list sprints -todo issues-in-sprint # issues in a sprint +mime-todo list # list all issues +mime-todo show # show issue details +mime-todo sprints # list sprints +mime-todo issues-in-sprint # issues in a sprint ``` ### Bugzilla Integration ```sh -todo init # check products/components exist -todo push # push commits to Bugzilla -todo push --dry-run # preview +mime-todo init # check products/components exist +mime-todo push # push commits to Bugzilla +mime-todo push --dry-run # preview ``` ### What Agents MUST NOT Do @@ -86,7 +86,7 @@ todo push --dry-run # preview - Edit the `TODO` file directly. - Construct `todo(): ` commits manually. - Modify issue fields other than `Status` (and only via the CLI). -- Push to Bugzilla outside of `todo push`. +- Push to Bugzilla outside of `mime-todo push`. - Modify the specification files. ## Rules for Agents diff --git a/src/README.rst b/src/README.rst index c5b3579..0a83008 100644 --- a/src/README.rst +++ b/src/README.rst @@ -614,7 +614,7 @@ Issue Lifecycle Creating an issue (MUST be on ``develop``):: - todo create --type feature --title "Add login" --plan "Implement OAuth2 flow" + mime-todo create --type feature --title "Add login" --plan "Implement OAuth2 flow" This produces a ``todo(): open`` commit modifying only the ``TODO`` file. The ``--plan`` text becomes the issue's ``Description`` field. The commit @@ -622,7 +622,7 @@ has no body because the description is already recorded in the issue itself. Starting work (MUST be on ``develop``):: - todo start --acceptance-criteria "What must be true for this to be done" + mime-todo start --acceptance-criteria "What must be true for this to be done" This produces a ``todo(): in-progress`` commit. The ``--acceptance-criteria`` text is stored in the issue's @@ -633,7 +633,7 @@ This produces a ``todo(): in-progress`` commit. The Completing work (MUST be on ``/``):: - todo done --acceptance "What was delivered against the criteria" + mime-todo done --acceptance "What was delivered against the criteria" This produces a ``todo(): done`` commit. The ``--acceptance`` text is stored in the issue's ``Acceptance`` field and becomes the commit body. @@ -641,11 +641,11 @@ The issue branch may then be merged into ``develop`` using ``--no-ff``. Holding an issue (MUST be on ``/``):: - todo hold --reason "Blocked on dependency" + mime-todo hold --reason "Blocked on dependency" Cancelling an issue (MUST be on ``develop`` or ``/``):: - todo cancel --reason "Superseded by issue #5" + mime-todo cancel --reason "Superseded by issue #5" The CLI validates the current branch and the status transition before committing. Invalid transitions or wrong branches are rejected with an @@ -657,29 +657,29 @@ Read-Only Commands These commands do not modify the ``TODO`` file and may be run from any branch:: - todo list # list all issues - todo show # show full issue details - todo sprints # list all sprints - todo issues-in-sprint # list issues in a sprint + mime-todo list # list all issues + mime-todo show # show full issue details + mime-todo sprints # list all sprints + mime-todo issues-in-sprint # list issues in a sprint Bugzilla Integration -------------------- Initializing products and components:: - todo init # check what exists - todo init --dry-run # preview changes - todo init --confirm --assignee user@example.com # create missing items + mime-todo init # check what exists + mime-todo init --dry-run # preview changes + mime-todo init --confirm --assignee user@example.com # create missing items The ``init`` command reads the ``application/bugzilla`` part and ensures all referenced products and components exist on the Bugzilla server. Pushing commits to Bugzilla:: - todo push # push all unpushed commits - todo push HEAD~3 # push only the last 3 commits - todo push --dry-run # preview without pushing - todo push --strategy full # re-scan all bugs + mime-todo push # push all unpushed commits + mime-todo push HEAD~3 # push only the last 3 commits + mime-todo push --dry-run # preview without pushing + mime-todo push --strategy full # re-scan all bugs On issue branches, ``push`` posts work commits as Bugzilla comments. Work comments are only permitted when the issue is ``in-progress`` and no @@ -697,11 +697,11 @@ Agent Usage Agents MUST use the CLI for all ``TODO`` file interactions: -* Creating issues: ``todo create`` -* Transitioning issues: ``todo start``, ``todo done``, ``todo hold``, - ``todo cancel`` -* Querying: ``todo list``, ``todo show``, ``todo sprints`` -* Syncing to Bugzilla: ``todo push`` +* Creating issues: ``mime-todo create`` +* Transitioning issues: ``mime-todo start``, ``mime-todo done``, ``mime-todo hold``, + ``mime-todo cancel`` +* Querying: ``mime-todo list``, ``mime-todo show``, ``mime-todo sprints`` +* Syncing to Bugzilla: ``mime-todo push`` Agents MUST NOT: