https://github.com/ttys3/git-credential-readonly
git-credential-readonly
https://github.com/ttys3/git-credential-readonly
Last synced: 9 months ago
JSON representation
git-credential-readonly
- Host: GitHub
- URL: https://github.com/ttys3/git-credential-readonly
- Owner: ttys3
- Created: 2023-03-13T18:20:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-11T04:57:39.000Z (almost 2 years ago)
- Last Synced: 2025-10-13T02:32:02.039Z (9 months ago)
- Language: Go
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# git-credential-readonly
this is a git credential helper that only reads from the credential store, and never writes to it.
in a word, it is a drop-in replacement for `git-credential-store` that only handle `get` action, and silently ignore `store` and `erase`.
it exists because the git built-in credential helper `store` will always write back to the credential store file.
which will cause problem when you have different store config for both user personal token and organization personal token.
for example:
```ini
[credential "https://github.com/org-name/"]
helper = readonly --file ~/.git-credentials-org
[credential]
helper = readonly
```
if you use `store` instead of `readonly`, it will always write back to the credential store file,
which will cause problem after you use organization token,
it will write the organization token back to the user credential store file.
so you personal token (by default in `~/.git-credentials`) will be overwritten by the organization token.
due to both auth host name are the same.
## install
```shell
go install github.com/ttys3/git-credential-readonly@latest
```
```shell
usage: `git-credential-readonly `
```
```shell
git config --global credential.helper readonly
```
## how to use with same host with diff token?
the credential.helper config sequence is important, git will match against it until it get the matched credentials.
so organization specific token should goes first.
```ini
# organization specific token
[credential "https://github.com/your-org/"]
helper = readonly --file ~/.git-credentials-org
# https://git-scm.com/docs/gitcredentials#Documentation/gitcredentials.txt-useHttpPath
# uncomment below if you need match path by username or org name
# for example: repo path `foo/bar.git`, will match path by `foo`
#useHttpPath = true
# general personal token
[credential]
helper = readonly
[url "https://github.com/"]
insteadOf = git@github.com:
```
the credential files:
`~/.git-credentials-org`:
```
https://username:org-token@github.com
```
`~/.git-credentials`:
```
https://username:personal-token@github.com
```
you can also use personal and org tokens in one file:
the config:
```ini
# github specific token
[credential "https://github.com/"]
helper = readonly --file ~/.git-credentials-org
# https://git-scm.com/docs/gitcredentials#Documentation/gitcredentials.txt-useHttpPath
# uncomment below if you need match path by username or org name
# for example: repo path `foo/bar.git`, will match path by `foo`
useHttpPath = true
```
the credential files:
`~/.git-credentials-org`:
```
https://username:personal-token@github.com/username
https://username:personal-token-for-org1@github.com/org-foo
https://username:personal-token-for-org2@github.com/org-bar
```
## docs
https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage#_a_custom_credential_cache