Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update README.md

Update README.md

Update README.md

Fix the storm link
  • Loading branch information
xwjdsh committed Jun 21, 2018
1 parent 3cc3f67 commit caf4491
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@

manssh is a command line tool for managing your ssh alias config easily, inspired by [storm](https://github.com/emre/storm) project, powered by Go.

Note:<br/>
This project is actually a simple glue project, the most complex and core parsing ssh config file logic implements by [ssh_config](https://github.com/kevinburke/ssh_config), I didn't do much.<br/>
At first it was just a imitation of [storm](https://github.com/emre/storm), now it has become a little different.

![](https://raw.githubusercontent.com/xwjdsh/manssh/master/screenshot/manssh.gif)

## Feature

* No dependence.
* Add, list, query, delete ssh alias record.
* Backup ssh config.

* [Support Include directive.](#for-include-directive)

## Install

Expand Down Expand Up @@ -56,7 +60,7 @@ COMMANDS:
list, l List or query SSH alias records
update, u Update SSH record by specifying alias name
delete, d Delete SSH records by specifying alias names
backup, b Backup SSH alias config records
backup, b Backup SSH config files
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
Expand Down Expand Up @@ -119,6 +123,35 @@ Rename the alias specified by `-r` flag.
✔ backup ssh config to [./config_backup] successfully.
```

## For Include directive
If you use the `Include` directive, there are some extra notes.

Add `-p`(--path) flag for `list`,`add`,`update`,`delete` command to show the file path where the alias is located, it can also be set by the **MANSSH_SHOW_PATH** environment variable.

<details>
<summary><strong><code>MANSSH_SHOW_PATH</code></strong></summary>

Set to `true` to show the file path where the alias is located. Default is `false`.
</details>
<br/>

Add `-ap`(--addpath) flag for `add` command to specify the file path to which the alias is added, it can also be set by the **MANSSH_ADD_PATH** environment variable.

<details>
<summary><strong><code>MANSSH_ADD_PATH</code></strong></summary>

This file path indicates to which file to add the alias. Default is the entry config file.
</details>
<br/>

For convenience, you can export these environments in your `.zshrc` or `.bashrc`,
example:

```bash
export MANSSH_SHOW_PATH=true
export MANSSH_ADD_PATH=~/.ssh/config.d/temp
```

## Thanks
* [kevinburke/ssh_config](https://github.com/kevinburke/ssh_config)
* [urfave/cli](https://github.com/urfave/cli)
Expand Down

0 comments on commit caf4491

Please sign in to comment.