Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yannoff/su-git
A simple tool to handle multiple git accounts on the same system
https://github.com/yannoff/su-git
git github gitlab ssh-key sudo
Last synced: about 1 month ago
JSON representation
A simple tool to handle multiple git accounts on the same system
- Host: GitHub
- URL: https://github.com/yannoff/su-git
- Owner: yannoff
- License: mit
- Created: 2017-11-26T16:12:02.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-26T10:59:52.000Z (about 1 year ago)
- Last Synced: 2023-10-26T11:44:27.518Z (about 1 year ago)
- Topics: git, github, gitlab, ssh-key, sudo
- Language: Shell
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# su-git
A simple tool to handle multiple git accounts, using multiple SSH keys.
## The reason
I ran into the problem when having to collaborate on 2 distincts `github` accounts simultaneously: my own account and the one I was running for my organization.
Here is the pitfall: each SSH key can be associated with one and **only** one account.
Unfortunately, `git` automatically takes the default key (typically `$HOME/.ssh/id_rsa`) for granted.
So creating a fresh new SSH key (let's say `$HOME/.ssh/id_rsa2`) and adding the corresponding public key to the repository was not enough to solve the problem.
Indeed, what `git` lacks is an option (like `--identity` on `ssh` command) to specify which private key should be used.
_And here comes **su-git**!_
## Installation
First, clone the project into a temporary directory:
```bash
$ cd /tmp
$ git clone https://github.com/yannoff/su-git.git
```
Then, go inside `su-git` directory,
```bash
$ cd su-git
```
then run:
```bash
$ make
$ sudo make install
```
Now `su-git` can be called from anywhere on your system.
## Usage
Prior to the first run of `su-git`, you need to configure which identity file will be used for the current dir:
```bash
$ git config ssh.identity /path/to/your/private_key
```
> **NOTE:** `su-git` leverages the powerful `git-config` engine to store its `ssh.identity` option.
_This means you can configure a global setting for your private key, and override it on a per-project level, as you would do for any other regular git configuration value._
Now you can use `su-git` for `push`/`pull` operations, exactly the same way as `git`, having your identity handled automatically.
**Example:**
1. Use `su-git` for cloning
```bash
$ su-git clone --identity ~/.ssh/your_rsa [email protected]:dummy/my-project.git
```
> **NOTE:** When cloning, there is no `.git` folder in the current directory, so `git config` cannot be used here, even if a global setting exists for `ssh.identity`.
2. Configure your identity file from inside the working dir
```bash
$ cd my-project
$ git config ssh.identity ~/.ssh/your_rsa
```
3. Work locally using `git`
```bash
$ git checkout -b feature/my-awesome-feature
...
$ git add .
$ git commit -m "My commit"
...
```
4. Use `su-git` when pushing your local branch
```bash
$ su-git push -u origin feature/my-awesome-feature
```
## Note
This project was proudly pushed using [su-git](https://github.com/yannoff/su-git "su-git project").
## License
Licensed under the [MIT License](LICENSE).