Skip to content

Commit 2d1211b

Browse files
bjcoombsCrunchyman-ralph
authored andcommitted
docs: Update help command with current tags and list options
Updates displayHelp() to reflect the actual command implementations: Tag Management: - Changed from old commands (add-tag, use-tag, delete-tag, rename-tag, copy-tag) to unified 'tags' subcommand structure (tags add, tags use, tags remove, tags rename, tags copy) - Added --ready option for tags list List command: - Added -s/--status and -t/--tag filter options - Added -f/--format, --json, -c/--compact output format options - Added -w/--watch for watch mode - Added --ready, --blocking, --all-tags filter options Fixes #1588
1 parent 9072630 commit 2d1211b

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

scripts/modules/ui.js

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -617,9 +617,19 @@ function displayHelp() {
617617
commands: [
618618
{
619619
name: 'list',
620-
args: '[<status>|all] [--with-subtasks]',
620+
args: '[<status>|all] [-s <status>] [-t <tag>]',
621621
desc: 'List all tasks - use "all" to show with subtasks'
622622
},
623+
{
624+
name: 'list',
625+
args: '[--with-subtasks] [-f <format>] [--json] [-c]',
626+
desc: 'Options: format (text/json/compact), subtasks'
627+
},
628+
{
629+
name: 'list',
630+
args: '[-w] [--ready] [--blocking] [--all-tags]',
631+
desc: 'Options: watch mode, ready/blocking filters, all tags'
632+
},
623633
{
624634
name: 'set-status',
625635
args: '<id> <status>',
@@ -741,33 +751,33 @@ function displayHelp() {
741751
commands: [
742752
{
743753
name: 'tags',
744-
args: '[--show-metadata]',
754+
args: '[list] [--show-metadata] [--ready]',
745755
desc: 'List all available tags with task counts'
746756
},
747757
{
748-
name: 'add-tag',
749-
args: '<tagName> [--copy-from-current] [--copy-from=<tag>] [-d="<desc>"]',
750-
desc: 'Create a new tag context for organizing tasks'
758+
name: 'tags add',
759+
args: '<name> [--description <desc>] [--copy-from <tag>]',
760+
desc: 'Create a new tag (--from-branch for git branch name)'
751761
},
752762
{
753-
name: 'use-tag',
754-
args: '<tagName>',
763+
name: 'tags use',
764+
args: '<name>',
755765
desc: 'Switch to a different tag context'
756766
},
757767
{
758-
name: 'delete-tag',
759-
args: '<tagName> [--yes]',
768+
name: 'tags remove',
769+
args: '<name> [-y]',
760770
desc: 'Delete an existing tag and all its tasks'
761771
},
762772
{
763-
name: 'rename-tag',
773+
name: 'tags rename',
764774
args: '<oldName> <newName>',
765775
desc: 'Rename an existing tag'
766776
},
767777
{
768-
name: 'copy-tag',
769-
args: '<sourceName> <targetName> [-d="<desc>"]',
770-
desc: 'Copy an existing tag to create a new tag with the same tasks'
778+
name: 'tags copy',
779+
args: '<source> <target> [--description <desc>]',
780+
desc: 'Copy a tag with all its tasks'
771781
}
772782
]
773783
},

0 commit comments

Comments
 (0)