https://github.com/gbernady/git-credential-op
A git credential helper powered by the 1Password CLI
https://github.com/gbernady/git-credential-op
1password 1password-cli git
Last synced: 5 months ago
JSON representation
A git credential helper powered by the 1Password CLI
- Host: GitHub
- URL: https://github.com/gbernady/git-credential-op
- Owner: gbernady
- License: mit
- Created: 2022-08-30T15:49:08.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T20:31:00.000Z (about 2 years ago)
- Last Synced: 2024-04-17T18:09:59.375Z (about 2 years ago)
- Topics: 1password, 1password-cli, git
- Language: Go
- Homepage:
- Size: 68.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-credential-op
[](https://github.com/gbernady/git-credential-op/actions?query=branch%3Amain)
[](https://goreportcard.com/report/github.com/gbernady/git-credential-op)
[](https://pkg.go.dev/github.com/gbernady/git-credential-op)
The `git-credential-op` is a custom Git credential helper built on top of [1Password CLI](https://developer.1password.com/docs/cli/get-started/).
You can use it to access remote repositories over HTTPS with credentials like GitHub's Personal Access Tokens (PATs) stored in [1Password](https://1password.com) instead of [built-in credential helpers](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage).
## Status
⚠️ WARNING: This project is **experimental**. Things might break or not work as expected.
### Features
- [x] Read credentials
- [ ] Store credentials
- [ ] Erase credentials
### Platforms
| Architecture | macOS | Linux | Windows |
|--------------|-------|-------|---------|
| x86 | N/A | ✕ | ✕ |
| amd64 | ✓ | ✓ | ✕ |
| arm64 | ✓ | ✓ | ✕ |
## Installation
I recommend downloading the latest build from GitHub [releases](https://github.com/gbernady/git-credential-op/releases) page and putting it somewhere on your `$PATH` (e.g. `/usr/local/bin`).
### Build from Sources
If you have [Go](https://go.dev) installed on your machine, you can also install the helper from sources with:
```sh
go install github.com/gbernady/git-credential-op/cmd/git-credential-op@latest
```
## Usage
Make sure you have the latest version of [1Password CLI](https://developer.1password.com/docs/cli/get-started/) installed on your system and you are signed in to your 1Password account. If everything is set up correctly, you should be able to list your vaults by running `op vault ls` in your terminal:
```sh
$ op vault ls
ID NAME
ynghx4vcntp3zvhqyehlcp7v7f Personal
```
Once you have [1Password CLI](https://developer.1password.com/docs/cli/get-started/) up and running, you can enable the credential helper in your git configuration with:
```sh
git config --global credential.helper op
```
Note: The credential helper only looks for credential saved in the `API Credential` category in 1Password.
### Configuration Flags
The credential helper accepts a few configuration flags that can be used to modify the default behavior like this:
```sh
git config --global credential.helper "op [flags]"
```
#### Flags
- `--account ` - the account to use (if more than one is available on the machine)
- `--vault ` - the vault to use; defaults to the `Personal` vault
## Troubleshooting
### Private Homebrew taps
Homebrew [filters envs including $PATH](https://github.com/Homebrew/brew/blob/master/bin/brew#L127), so it won't be able to find the `git-credential-op` helper. This can be worked around with an [absolute path to the binary](https://git-scm.com/docs/gitcredentials#_custom_helpers).
On top op that, the user environment set up by Homebrew for installing formulae does not contain any local machine configs like the `$HOME/.gitconfig`.
### Disabling System Helper
On some machines (e.g., running macOS), a credential helper may already be configured in the system-wide `$(prefix)/etc/gitconfig` file. Since the system-wide configuration is read first by Git, that helper will be consulted before this one to store the credential and return in on subsequent use.
If that's not what you want, you can either modify the system-wide config file or disable reading it altogether with the [GIT_CONFIG_NOSYSTEM](https://git-scm.com/docs/git-config#Documentation/git-config.txt-GITCONFIGNOSYSTEM) environment variable:
```sh
export GIT_CONFIG_NOSYSTEM=1
```
## License
The code is licensed under the [MIT License](./LICENSE).