Repository navigation
Document all capabilities of the browse command #5352
Description
CLI Feedback
What was confusing or gave you pause?
My hands keep typing gh repo browse because presumably the repo-related
commands are grouped under gh repo sub-command.
However, the browse subcmd is a root level subcmd. The reasoning is somewhat
unclear to me. If you decide to rework this, hopefully this provides a data
point.
Activity
[-]root 'browse' command ideally should be under 'repo' subcommand[/-][+]Root-level 'browse' command ideally should be under 'repo' subcommand[/+]mislav commentedon Mar 25, 2022
Hi, thanks for the feedback!
An argument could be made for
browseto be underrepo, but thebrowsecommand is useful not just to browse the repository home page, but also for files, issues, pull requests, wikis, and so on. Ourgh issueandgh prcommands aren't underrepo(even though Issues and Pull Request technically are always under a Repository), and becausebrowseencompasses all those items, we've felt like it should also be a top-level command. It's also much shorter to type that way.ahmetb commentedon Mar 25, 2022
Then the command description is not up to date regarding the ability to open files/issues/PRs etc.
https://cli.github.com/manual/gh_browse
mislav commentedon Mar 28, 2022
Ah, good point! I agree that the docs are lacking. There is this example:
But this capability should be noted in prose above as well. I will reopen and relabel this issue to be a request to improve documentation.
[-]Root-level 'browse' command ideally should be under 'repo' subcommand[/-][+]Document all capabilities of the browse command[/+]bunnymatic commentedon Jan 9, 2024
Hi
I'm just moving away from
huband found thebrowsedoesn't act like hub and would love it if it did.hub browsewill navigate to the branch you're on which means I can doand quickly submit the PR and then open the web view so I can add screenshots or read what I just submitted and review or whatever.
But if I
I just get to the repo main so then I need more clicks and whatever to navigate to the thing I just put up.
I see that there is a way to
gh browse <args>that might get me to the PR but then I have to find those args.Have you considered
gh browsegoing to the the repo and the branch based on where you are on in the terminal?Quick add - love much of the
ghcli so far. but I still wanthubaround for that one little trick.bunnymatic commentedon Mar 1, 2024
well, I just found the replacement.
so I guess I don't really need the
browse.docs: improve docs for browse command as of cli#5352
Merge pull request #10025 from ankddev/update-browse-docs
build(deps): update cli/cli to v2.64.0
Bruss62 commentedon Jan 6, 2025