Skip to content

Add CLI documentation with usage and alias instructions#124

Merged
pol-rivero merged 2 commits into
pol-rivero:mainfrom
guplem:feature/github-plus-cli-alias
Apr 6, 2026
Merged

Add CLI documentation with usage and alias instructions#124
pol-rivero merged 2 commits into
pol-rivero:mainfrom
guplem:feature/github-plus-cli-alias

Conversation

@guplem

@guplem guplem commented Apr 6, 2026

Copy link
Copy Markdown

Summary

  • Adds a new docs/cli.md with a quick CLI usage showcase and shell alias instructions (PowerShell, Bash/Zsh, Fish)
  • Adds a brief "Command Line Interface" section to the README linking to the doc

Test plan

  • Verify docs/cli.md renders correctly
  • Verify the README link works

@guplem guplem force-pushed the feature/github-plus-cli-alias branch 2 times, most recently from b906947 to 24bdf9d Compare April 6, 2026 09:44
@guplem guplem changed the title Add github-plus CLI alias for terminal launch Rename CLI command from github-desktop-plus-cli to github-plus Apr 6, 2026
@pol-rivero

pol-rivero commented Apr 6, 2026

Copy link
Copy Markdown
Owner

I considered naming it github-plus back when I was renaming everything to make this fork compatible with the upstream, but at the end I decided to use github-desktop-plus-cli for consistency and to ensure it would never conflict with other programs.

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 github if they want to return to the old name). The project should provide a sufficiently unique name that makes sense as a default. I don't think github-plus is sufficiently unique.

If you tell me which shell you are using, I can search the corresponding instructions for creating an alias. :)

@guplem

guplem commented Apr 6, 2026

Copy link
Copy Markdown
Author

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.

@guplem guplem force-pushed the feature/github-plus-cli-alias branch from 0dbe74a to 2ce3829 Compare April 6, 2026 10:02
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@guplem guplem changed the title Rename CLI command from github-desktop-plus-cli to github-plus Add CLI alias instructions to README Apr 6, 2026
@guplem

guplem commented Apr 6, 2026

Copy link
Copy Markdown
Author

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.

@pol-rivero

Copy link
Copy Markdown
Owner

Would it be useful to add a short section to the README with instructions on how to create a shell alias?

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>
@guplem guplem changed the title Add CLI alias instructions to README Add CLI documentation with usage and alias instructions Apr 6, 2026
@guplem

guplem commented Apr 6, 2026

Copy link
Copy Markdown
Author

I've updated the PR: moved the content to a separate docs/cli.md (following the same pattern as docs/known-issues.md) with a CLI usage showcase and alias instructions. The README now just has a brief section linking to it.

@pol-rivero

Copy link
Copy Markdown
Owner

Great job as always :)

@pol-rivero pol-rivero merged commit 9abedf2 into pol-rivero:main Apr 6, 2026
11 checks passed
@guplem guplem deleted the feature/github-plus-cli-alias branch April 6, 2026 10:21
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.

2 participants