https://github.com/netlify/netlify-credential-helper
Git credential helper to use Netlify's API as authentication backend
https://github.com/netlify/netlify-credential-helper
Last synced: about 2 months ago
JSON representation
Git credential helper to use Netlify's API as authentication backend
- Host: GitHub
- URL: https://github.com/netlify/netlify-credential-helper
- Owner: netlify
- License: mit
- Created: 2018-11-30T22:36:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-07T21:47:57.000Z (almost 2 years ago)
- Last Synced: 2025-04-26T16:59:27.719Z (about 2 months ago)
- Language: Go
- Homepage:
- Size: 3.07 MB
- Stars: 18
- Watchers: 26
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Netlify Git's credential helper
Netlify Git's credential helper is a program compatible with [Git Credential Helpers](https://git-scm.com/docs/gitcredentials)
that uses Netlify's API to authenticate a user.
## Install
Our preferred way to install this software is by using Netlify CLI:
1. Install Netlify CLI if you have not yet: `npm install -g netlify-cli`
2. Run `netlify lm:install`.
`netlify lm:install` command will download the latest version of this sofware
for your OS, and configure Git to use it when it's necessary. You don't need to
do anything else.
Alternatively, you can also install this credentials helper manually following one of the guides below:
- [Install on Debian/Ubuntu](#install-on-debianubuntu)
- [Install on Fedora/RedHat](#install-on-fedoraredhat)
- [Install on MacOS X](#install-on-macos-x-with-homebrew)
- [Install on Windows with Powershell](#install-on-windows-with-powershell)
- [Install on Windows with Scoop](#install-on-windows-with-scoop)
- [Manual install](#manual-install)
After manually installing the helper, you'll need to add the credential definition to you Git config:
```
[credential]
helper = netlify
```
### Install on Debian/Ubuntu
1. Download the deb file from our [Releases]("https://github.com/netlify/netlify-credential-helper/releases").
2. Install with dpkg:
```
sudo dpkg -i git-credential-netlify-linux-amd64.deb
```
### Install on Fedora/RedHat
1. Download the rpm file from our [Releases]("https://github.com/netlify/netlify-credential-helper/releases").
2. Install with dpkg:
```
sudo dnf install git-credential-netlify-linux-amd64.rpm
```
### Install on MacOS X with Homebrew
1. Open a terminal and copy these two commands:
```
brew tap netlify/git-credential-netlify
brew install git-credential-netlify
```
### Install on Windows with Powershell
1. Start a Powershell session and copy these two commands:
```
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
iex (iwr -UseBasicParsing -Uri https://github.com/netlify/netlify-credential-helper/raw/master/resources/install.ps1)
```
### Install on Windows with Scoop
1. Start a Powershell session and copy these two commands:
```
scoop bucket add netlifyctl https://github.com/netlify/scoop-git-credential-netlify
scoop install git-credential-netlify
```
### Manual install
1. Download the release binary specific for your OS and CPU architecture from our [Releases]("https://github.com/netlify/netlify-credential-helper/releases").
2. Extract the binary in your PATH.
## Usage with Netlify Large Media
When Git requires your authentication token to push large media to your server, it will invoke this binary directly.
If you're not logged in in Netlify, Git will give you the option to login. After this first login, this helper will
store your authentication token for future usage so you don't have to login again.
## Development
Go 1.11 or above is required to make changes in this program.
Use `make deps` to install dependencies, `make test` to run tests, and `make build` to build the binaries.
## Release
1. Install `hub` https://hub.github.com/
2. Create a [GitHub personal access token](https://github.com/settings/tokens/new) and add it to your shell (e.g. `export GITHUB_TOKEN=`)
3. Use `make release TAG=0.1.X` to build all packages and create a release in GitHub Releases.
## License
[MIT](./LICENSE)