Add CLI documentation with usage and alias instructions#124
Conversation
b906947 to
24bdf9d
Compare
github-plus CLI alias for terminal launchgithub-desktop-plus-cli to github-plus
|
I considered naming it My rationale is that if users want to use a shorter name, they can easily create an alias in their shell configs (they can even name it just If you tell me which shell you are using, I can search the corresponding instructions for creating an alias. :) |
|
Fair enough, that makes sense! I hadn't considered the uniqueness angle. Would it be useful to add a short section to the README with instructions on how to create a shell alias? That way users who want a shorter command can set it up easily regardless of their OS/shell. |
0dbe74a to
2ce3829
Compare
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
github-desktop-plus-cli to github-plus|
I've updated the PR to add a "Creating a CLI alias" section to the README instead, with instructions for PowerShell, Bash/Zsh, and Fish. |
Absolutely! In fact, right now I think we are never explaining the fact that the CLI command even exists, so it would make sense to have a section with a quick showcase and instructions for creating the alias. Right now, I think the README is already a bit long, so maybe we could create a separate markdown file and link to it in a small readme section (just like we did in the Common issues section). |
…ions Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
I've updated the PR: moved the content to a separate |
|
Great job as always :) |
Summary
docs/cli.mdwith a quick CLI usage showcase and shell alias instructions (PowerShell, Bash/Zsh, Fish)Test plan
docs/cli.mdrenders correctly