gmgauthier/grokkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 23 Wiki Activity

docs(workon): clarify -c flag usage and exclusivity
Some checks failed
CI / Test (push) Successful in 33s
Details
CI / Lint (push) Successful in 25s
Details
CI / Build (push) Has been cancelled
Details

Browse Source 
Updated the usage string to show -c as an alternative option and added a note
that it cannot be used with other flags.
This commit is contained in:
Gregory Gauthier 2026-03-31 15:12:50 +01:00
parent 5f864307b8
commit d752a73742
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
todo/queued/workon.md
View File

@ -23,7 +23,7 @@ Also, if no IDE is specified in the config, the feature will default to not open
**Usage**: **Usage**:
``` ```
grokkit workon <todo_item_title> [-m '<custom_commit_message>'] [-f] grokkit workon <todo_item_title> [[-m '<custom_commit_message>'] [-f]] | [-c]
``` ```
**Arguments**: **Arguments**:
@ -36,7 +36,7 @@ grokkit workon <todo_item_title> [-m '<custom_commit_message>'] [-f]
- `-f`: This signifies a "fix" rather than a todo item (the default is always a todo item) - `-f`: This signifies a "fix" rather than a todo item (the default is always a todo item)
- `-c`: "completes" the work item. This means: - `-c`: "completes" the work item (note: cannot be used with other flags). This means:
- If it is a todo, it will be moved to the "completed" folder, and the index readme will be updated. - If it is a todo, it will be moved to the "completed" folder, and the index readme will be updated.
- If it is a fix, the work plan will be moved to the "completed folder". No index update is necessary. - If it is a fix, the work plan will be moved to the "completed folder". No index update is necessary.
- In either case, the update will be committed to the branch. - In either case, the update will be committed to the branch.