gam's Introduction

GAM

(Git Alias Manager)

GAM is a CLI application (with an API component) written in NodeJS for managing multiple Git accounts (aliases).

Installation

With NPM locally

to use the API

$ npm i git-alias-manager

With NPM globally

to use the CLI

$ npm i git-alias-manager -g

Without NPM

Download install.py, then run the following command in the directory where install.py was downloaded:

$ python ./install.py

CLI Usage

To create a public and private key for a new alias

$ gam create-alias

To change the current alias:

$ gam change-alias

To view the email of the current alias:

$ gam current-alias-email

To delete a public and private key for an alias

$ gam delete-alias

To view a full list of commands and options:

$ gam help

API Usage

Please see API.md

Contributing

Please see CONTRIBUTING.md

Known Issues

If you run build.sh in zshell, you may receive:

zsh compinit: insecure directories and files, run compaudit for list.
Ignore insecure directories and files and continue [y] or abort compinit [n]?

If you receive this, please run build.sh again and the error will not appear.

License

Copyright 2020 Seth Wheeler

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

gam's People

Contributors

Stargazers

Watchers

gam's Issues

ssh key not found in directory when it does in fact exist

Running ls /home/user/.ssh/
gives
id_rsa id_rsa.pub id_rsa_Scarycrumb45 id_rsa_Scarycrumb45.pub known_hosts

Full Error:

Adding SSH Keys to the SSH authentication agent...
/usr/local/lib/node_modules/git-alias-manager/src/methods.js:187
  throw (new Error(`File: id_rsa_${alias} not found in directory: ${dir}`));
         ^

Error: File: id_rsa_Scarycrumb45 not found in directory: /home/user/.ssh
    at Object.addSshKeyAgent (/usr/local/lib/node_modules/git-alias-manager/src/methods.js:187:10)
    at /usr/local/lib/node_modules/git-alias-manager/src/manager.js:35:21
    at async /usr/local/lib/node_modules/git-alias-manager/src/manager.js:33:5

SSH keys not generating automatically

I tried creating an alias, and received this output:

Generating SSH Keys...

Adding SSH Keys to the SSH authentication agent...
node:internal/process/promises:279
            triggerUncaughtException(err, true /* fromPromise */);
            ^

Error: File: id_rsa_mleland18 not found in directory: /Users/matthewleland/.ssh
    at Object.addSshKeyAgent (/snapshot/node_modules/git-alias-manager/src/methods.js)
    at /snapshot/node_modules/git-alias-manager/src/manager.js
    at async /snapshot/node_modules/git-alias-manager/src/manager.js

This is my first time trying to set up an alias using gam.

Recommend Projects