Skip to content

fix: help examples referencing non-existent commands - #305

Merged
lucassabreu merged 5 commits into
lucassabreu:mainfrom
nikosavola:fix/help-examples
Sep 17, 2026
Merged

lucassabreu merged 5 commits into
lucassabreu:mainfrom
nikosavola:fix/help-examples

Conversation

@nikosavola

Copy link
Copy Markdown
Contributor

Fixes #304

  • config help examples now use config set/get (and config list for the no-arg case) instead of the non-existent root-level get/set
  • project edit help examples include the edit subcommand, quote the --color value and show the correct --archived output
  • task done help examples show clockify-cli task done -p cli <task> instead of the invalid clockify-cli task -p cli done <task>
  • user me help example no longer passes --email, a flag the me subcommand does not have
  • completion help points to bash_completion.d (was bash_cmdcompl.d, a leftover of the cmdcompl package rename) and the duplicated Linux section is gone

CHANGELOG.md updated under [Unreleased] / Fixed, one bullet per commit.

nikosavola and others added 5 commits September 17, 2026 14:48
- 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>
@nikosavola
nikosavola marked this pull request as ready for review September 17, 2026 11:59
@lucassabreu
lucassabreu merged commit ef61a4a into lucassabreu:main Sep 17, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Help examples reference non-existent commands

2 participants