utils-code/x-motemen.ghq
1
0
Fork 0
mirror of https://github.com/x-motemen/ghq.git synced 2026-09-10 07:26:27 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #430 from mitsu-yuki/master

Browse source 
docs: add description for `ghq.user` and `ghq. completeUser`
This commit is contained in:
Masayuki Matsuki 2025-12-21 14:57:39 +09:00 committed by GitHub
parent 4f4abb143d 66a60071be
commit 650c877e62
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.adoc
View file

@ -79,6 +79,19 @@ ghq.root::
want to specify "$GOPATH/src" as a secondary root (environment variables
should be expanded.)
ghq.user::
In ghq, when specifying only the repository name without slashes as in `ghq get {{Project}}`,
ghq attempts to auto-complete the repository owner.
By default, the owner used is the value of the environment variable `USER` (or `USERNAME` on Windows).
Setting this option allows you to explicitly specify the owner.
ghq.completeUser::
Rather than always using your own username for owner completion,
you may want to complete the owner with the same name as the repository.
For example, fetch `ruby` as `github.com/ruby/ruby`,
`vim` as `github.com/vim/vim`, and `peco` as `github.com/peco/peco`.
If you prefer this behavior, set this option to `false` to switch the owner completion method.
ghq.<url>.vcs::
ghq tries to detect the remote repository's VCS backend for non-"github.com"
repositories. With this option you can explicitly specify the VCS for the