Skip to content

Commit 19954e4

Browse files
authored
Update tags comment (#2)
* refactor: Update tags comment on help menu * Update USAGE
1 parent 2dda0ea commit 19954e4

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

USAGE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Set the AWS region either in your AWS credentials or environment variables (`AWS
1010
## Environment Variables
1111
To using `awssh` you can setup your configuration from environment variables as follows:
1212
* `AWSSH_DEBUG`: Enabled debug mode for `awssh`. Default to `0` (false).
13-
* `AWSSH_TAGS`: List of EC2 tags key-value pair. Default to `"Name=*"`.
13+
* `AWSSH_TAGS`: A comma-separated key-value pairs of EC2 tags. Ex: 'Name=ec2,Environment=staging'. Default to `"Name=*"`.
1414
* `AWSSH_SSH_USERNAME`: An EC2 ssh username. Default to `ec2-user`.
1515
* `AWSSH_SSH_PORT`: An EC2 ssh port. Default to `22`.
1616
* `AWSSH_SSH_OPTS`: An additional ssh options. Default to `"-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/nul -o ConnectTimeout=5"`
@@ -53,7 +53,7 @@ Flags:
5353
-o, --ssh-opts string An additional ssh options (default "-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null")
5454
-p, --ssh-port string An EC2 instance ssh port (default "22")
5555
-u, --ssh-username string EC2 SSH username (default "ec2-user")
56-
-t, --tags string EC2 tags key-value pair (default "Name=*")
56+
-t, --tags string A comma-separated key-value pairs of EC2 tags. Ex: 'Name=ec2,Environment=staging' (default "Name=*")
5757
--use-public-ip Use public IP to access the EC2 instance
5858
```
5959
### Debug Mode

internal/cli/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func MakeRoot() *cobra.Command {
5050

5151
command.Flags().BoolVarP(&appConfig.Debug, "debug", "d", appConfig.Debug, "Enabled debug mode")
5252
command.Flags().StringVar(&appConfig.Region, "region", appConfig.Region, "Default AWS region to be used. Either set AWS_REGION or AWS_DEFAULT_REGION")
53-
command.Flags().StringVarP(&appConfig.Tags, "tags", "t", appConfig.Tags, "EC2 tags key-value pair")
53+
command.Flags().StringVarP(&appConfig.Tags, "tags", "t", appConfig.Tags, "A comma-separated key-value pairs of EC2 tags. Ex: 'Name=ec2,Environment=staging'")
5454
command.Flags().StringVarP(&appConfig.SSHUsername, "ssh-username", "u", appConfig.SSHUsername, "EC2 SSH username")
5555
command.Flags().StringVarP(&appConfig.SSHPort, "ssh-port", "p", appConfig.SSHPort, "An EC2 instance ssh port")
5656
command.Flags().StringVarP(&appConfig.SSHOpts, "ssh-opts", "o", appConfig.SSHOpts, "An additional ssh options")

0 commit comments

Comments
 (0)