Skip to content
This repository has been archived by the owner on Dec 21, 2022. It is now read-only.

Polished the README #10

Merged
merged 1 commit into from
May 26, 2013
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 58 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,76 @@
storm
=====
# storm

storm is a command line tool to manage your ssh connections.

<img src="https://raw.github.com/emre/storm/master/ss.png">

### installation ###
## installation

$ [sudo] pip install stormssh

```
pip install stormssh
```
or if you like 90s:

```
easy_install stormssh
```
$ [sudo] easy_install stormssh

or download add storm directory to the your `$PATH`. E.g.

$ git clone git://github.com/emre/storm.git
$ export PATH=$PATH:`pwd`/storm/storm/bin/; storm

or add storm directory to the your path.
## getting started

### getting started ###
### adding hosts

$ storm add [-h] [--port PORT] [--id_file ID_FILE] name host user

Where `-h`, `id_file` and `port` are optional arguments.

**adding hosts**
```
storm add [-h] [--port PORT] [--id_file ID_FILE] name host user
```

id_file and port are optional arguments.

example:
```
$ storm add my_vps emreyilmaz.me root
my_vps added to your ssh config. you can connect it by typing "ssh my_vps".
```

**modifying hosts**
```
storm edit [-h] [--port PORT] [--id_file ID_FILE] name host user
```

id_file and port are optional arguments.


$ storm add my_vps emreyilmaz.me root
my_vps added to your ssh config. you can connect it by typing "ssh my_vps".

### modifying hosts

storm edit [-h] [--port PORT] [--id_file ID_FILE] name host user

Where `-h`, `id_file` and `port` are optional arguments.

example:
```
$ storm edit my_vps emreyilmaz.me emre --port=88
"my_vps" updated successfully.
```

**deleting a single host**
```
storm delete name
```


$ storm edit my_vps emreyilmaz.me emre --port=88
"my_vps" updated successfully.

### deleting a single host

$ storm delete name

example:
```
$ storm delete my_vps
success hostname "my_vps" deleted successfully.
```

**listing hosts**
```
$ storm list
Listing hosts:
vps -> 22@emreyilmaz.me:22
netscaler -> root@127.0.0.1:8081
```

**deleting all hosts**
```
$ storm delete_all
all entries deleted.
```

### known issues ###
If you use zsh on mac and getting "command not found: storm" for main storm script, make sure you have storm in your PATH.

$ storm delete my_vps
success hostname "my_vps" deleted successfully.

### listing hosts

$ storm list
Listing hosts:
vps -> 22@emreyilmaz.me:22
netscaler -> root@127.0.0.1:8081

### deleting all hosts

$ storm delete_all
all entries deleted.

## known issues

If you use zsh on a mac and get "command not found: storm" for main storm script, make sure you have storm in your PATH.

example:
```
export PATH=$PATH:/usr/local/share/python/; storm
```

$ export PATH=$PATH:/usr/local/share/python/; storm

## contributors

### contributors ###
- <a href="http://github.com/ras0ir">Samed Beyribey</a> - PKGBUILD for Archlinux and testing excessive ssh configs.</a>
- <a href="http://github.com/benvand">@benvand</a>
- <a href="http://github.com/ras0ir">Samed Beyribey</a> - PKGBUILD for Archlinux and testing excessive ssh configs.</a>
- <a href="http://github.com/benvand">@benvand</a>