Repository navigation
fix: help examples referencing non-existent commands - #305
Merged
Merged
Conversation
- examples showed `clockify-cli get/set` which are not valid commands, they live under `clockify-cli config get/set` - the no-arg `get` example became `config list`, as `config get` requires a param Co-Authored-By: GLM 5.3 <noreply@z.ai>
- three examples invoked `clockify-cli project <id>` directly, which is not a command; they now read `clockify-cli project edit <id>` - quote the color flag value (`--color=#0f0`), as `# ` starts a comment in the shell, and fix the `--archived` sample output Co-Authored-By: GLM 5.3 <noreply@z.ai>
- examples rendered as `clockify-cli task -p cli ls` and `clockify-cli task -p cli done <task>`, but `task` has no `-p` flag nor is it a valid subcommand invocation; they now read `clockify-cli task ls -p cli` and `clockify-cli task done -p cli <task>` Co-Authored-By: GLM 5.3 <noreply@z.ai>
- help showed `/etc/bash_cmdcompl.d/` and `/usr/local/etc/bash_cmdcompl.d/`, leftovers of the package rename to `cmdcompl`; bash-completion loads scripts from `bash_completion.d` - drop the duplicated Linux section that repeated the Bash instructions verbatim Co-Authored-By: GLM 5.3 <noreply@z.ai>
- `--email` is a local flag of `user`, not of `user me`; drop it from the example (email filtering is meaningless for the token owner anyway) Co-Authored-By: GLM 5.3 <noreply@z.ai>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #304
confighelp examples now useconfig set/get(andconfig listfor the no-arg case) instead of the non-existent root-levelget/setproject edithelp examples include theeditsubcommand, quote the--colorvalue and show the correct--archivedoutputtask donehelp examples showclockify-cli task done -p cli <task>instead of the invalidclockify-cli task -p cli done <task>user mehelp example no longer passes--email, a flag themesubcommand does not havecompletionhelp points tobash_completion.d(wasbash_cmdcompl.d, a leftover of thecmdcomplpackage rename) and the duplicated Linux section is goneCHANGELOG.md updated under [Unreleased] / Fixed, one bullet per commit.