README.md in ec2ssh-2.0.0 vs README.md in ec2ssh-2.0.1
- old
+ new
@@ -1,5 +1,7 @@
+[](https://travis-ci.org/mirakui/ec2ssh)
+
# Introduction
ec2ssh is a ssh_config manager for amazonaws ec2.
`ec2ssh` command adds `Host` descriptions to ssh_config (~/.ssh/config default). 'Name' tag of instances are used as `Host` descriptions.
# How to use
@@ -49,16 +51,33 @@
$ ec2ssh init # Add ec2ssh mark to ssh_config
$ ec2ssh update # Update ec2 hosts list in ssh_config
$ ec2ssh remove # Remove ec2ssh mark from ssh_config
```
-Each command can use `--path` option to set ssh_config path. The default is "~/.ssh/config"
+## Options
+### --path
+Each command can use `--path` option to set ssh_config path. `~/.ssh/config` is default.
```
-$ ec2ssh init --path=/path/to/ssh_config
+$ ec2ssh init --path /path/to/ssh_config
```
+### --dotfile
+Each command can use `--dotfile` option to set dotfile (.ec2ssh) path. `~/.ec2ssh` is default.
+
+```
+$ ec2ssh init --dotfile /path/to/ssh_config
+```
+
+### --aws-key
+`ec2ssh update` allows `--aws-key` option. If you have multiple aws keys, you can choose from them as you like using this option. See Dotfile section for details.
+
+```
+$ ec2ssh update --aws-key my_key1
+```
+
+
# ssh_config and mark lines
`ec2ssh init` command inserts mark lines your `.ssh/config` such as:
```
### EC2SSH BEGIN ###
@@ -83,9 +102,64 @@
:
### EC2SSH END ###
```
`ec2ssh remove` command removes the mark lines.
+
+# Dotfile (.ec2ssh)
+Dotfile (`.ec2ssh`) is a feature which is released at v2.0.0. A template of `.ec2ssh` is created when you execute `ec2ssh init`.
+
+```
+$ ec2ssh init
+$ cat ~/.ec2ssh
+---
+path: /home/yourname/.ssh/config
+aws_keys:
+ default:
+ access_key_id: ...(Filled by ENV['AMAZON_ACCESS_KEY_ID']
+ secret_access_key: ...(Filled by ENV['AMAZON_SECRET_ACCESS_KEY'])
+regions:
+- ap-northeast-1
+```
+
+## multiple aws keys
+You can use multiple aws keys at `ec2ssh update` with `--aws-key` option.
+
+```
+$ cat ~/.ec2ssh
+---
+path: /home/yourname/.ssh/config
+aws_keys:
+ default:
+ access_key_id: ...
+ secret_access_key: ...
+ my_key1:
+ access_key_id: ...
+ secret_access_key: ...
+regions:
+- ap-northeast-1
+```
+
+Updating ssh_config by 'default' aws key:
+
+```
+$ ec2ssh update
+```
+
+Updates ssh_config by 'my_key1' aws key:
+
+```
+$ ec2ssh update --aws-key my_key1
+```
+
+# How to upgrade from 1.x to 2.x
+If you have used ec2ssh-1.x, it seems that you may not have '~/.ec2ssh'.
+So you need execute `ec2ssh init` once to create `~/.ec2ssh`, and edit it as you like.
+
+```
+$ ec2ssh init
+$ vi ~/.ec2ssh
+```
# Notice
`ec2ssh` command updates your `.ssh/config` file default. You should make a backup of it.
# License