-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #48 from Megapixel99/develop
Develop
- Loading branch information
Showing
5 changed files
with
58 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
## Methods | ||
### AddSshKeyAgent | ||
### addSshKeyAgent | ||
###### Params: | ||
`alias` - The name of the Alias | ||
|
||
|
@@ -15,7 +15,7 @@ console.log('Folder: ' + gam.addSshKeyAgent('alias', '/.ssh')); | |
``` | ||
No output | ||
|
||
### Backup | ||
### backup | ||
###### Params: | ||
`dir` - Optional, the directory to use, defaults to the `.ssh` folder in the users home directory | ||
|
||
|
@@ -171,7 +171,7 @@ Would output: | |
Alias: alias | ||
``` | ||
|
||
### GenerateKey | ||
### generateKey | ||
###### Params: | ||
`alias` - The name of the Alias | ||
|
||
|
@@ -193,3 +193,25 @@ console.log(gam.generateKey('alias', 'email', | |
'passphrase', 2048, '/.ssh'); | ||
``` | ||
No output | ||
### getAliasEmail | ||
###### Params: | ||
`alias` - The name of the Alias | ||
`dir` - Optional, the directory to search in, defaults to the `.ssh` folder in the users home directory | ||
###### Description: | ||
Retrieves the email associated with an alias | ||
##### Example: | ||
```javascript | ||
const gam = require('git-alias-manager'); | ||
console.log(gam.getAliasEmail('alias', '/.ssh'); | ||
``` | ||
Would output: | ||
```json | ||
{ | ||
"email": "[email protected]" | ||
} | ||
``` |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters