3.2.0 • Published 4 years ago
@hlacannon/aws-ec2-profiles v3.2.0
@hlacannon/aws-ec2-profiles
Usage
$ npm install -g @hlacannon/aws-ec2-profiles
$ aep COMMAND
running command...
$ aep (-v|--version|version)
@hlacannon/aws-ec2-profiles/3.2.0 win32-x64 node-v12.16.3
$ aep --help [COMMAND]
USAGE
$ aep COMMAND
...
$ npm install -g @hlacannon/aws-ec2-profiles
$ aep COMMAND
running command...
$ aep (-v|--version|version)
@hlacannon/aws-ec2-profiles/3.1.0 win32-x64 node-v12.16.3
$ aep --help [COMMAND]
USAGE
$ aep COMMAND
...
Commands
aep accounts [ACTION]
Display registered AWS accounts
USAGE
$ aep accounts [ACTION]
ARGUMENTS
ACTION (add|remove|edit) Add, remove or modify an account
OPTIONS
-d, --detail Show extra instance details
DESCRIPTION
Display registered AWS accounts
See code: src\commands\accounts.js
aep configure
Configure the CLI
USAGE
$ aep configure
DESCRIPTION
Add accounts and customise the CLI tool
See code: src\commands\configure.js
aep connect
Connect using SSH to an EC2 instance
USAGE
$ aep connect
OPTIONS
-a, --address=address Instance Address
-d, --directory=directory Override pem file directory
-i, --index=index Instance index
-n, --name=name Instance name
-u, --username=username Override connection username
DESCRIPTION
Connect to an EC2 instance using either the instance index, name or address.
Ability to override username and/or pem directory
See code: src\commands\connect.js
aep help [COMMAND]
display help for aep
USAGE
$ aep help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
aep list
Display EC2 instances
USAGE
$ aep list
OPTIONS
-a, --account=account
[default: all] Only get instances from a specific account(s)
-d, --detail
Show extra instance details
-r,
--region=us-east-1|us-east-2|us-west-1|us-west-2|ap-south-1|ap-northeast-1|ap-northeast-2|ap-southeast-1|ap-southeast-
2|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1|sa-east-1
[default: all] Only update security groups in a specific region(s)
-s, --state=pending|running|stopping|stopped|shutting-down|terminated
[default: all] Only get instances of in a specific state(s)
DESCRIPTION
Gathers up to date EC2 instance data and displays summaries in a table
See code: src\commands\list.js
aep update
Update security groups with your new public IP
USAGE
$ aep update
OPTIONS
-r,
--region=us-east-1|us-east-2|us-west-1|us-west-2|ap-south-1|ap-northeast-1|ap-northeast-2|ap-southeast-1|ap-southeast-
2|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1|sa-east-1
[default: all] Only update security groups in a specific region(s)
DESCRIPTION
Checks if your public IP has changed and updates relevant AWS security groups
See code: src\commands\update.js
aep accounts [ACTION]
Display registered AWS accounts
USAGE
$ aep accounts [ACTION]
ARGUMENTS
ACTION (add|remove|edit) Add, remove or modify an account
OPTIONS
-d, --detail Show extra instance details
DESCRIPTION
Display registered AWS accounts
See code: src\commands\accounts.js
aep configure
Configure the CLI
USAGE
$ aep configure
DESCRIPTION
Add accounts and customise the CLI tool
See code: src\commands\configure.js
aep connect
Connect using SSH to an EC2 instance
USAGE
$ aep connect
OPTIONS
-a, --address=address Instance Address
-d, --directory=directory Override pem file directory
-i, --index=index Instance index
-n, --name=name Instance name
-u, --username=username Override connection username
DESCRIPTION
Connect to an EC2 instance using either the instance index, name or address.
Ability to override username and/or pem directory
See code: src\commands\connect.js
aep help [COMMAND]
display help for aep
USAGE
$ aep help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
aep list
Display EC2 instances
USAGE
$ aep list
OPTIONS
-a, --account=account
[default: all] Only get instances from a specific account(s)
-d, --detail
Show extra instance details
-r,
--region=us-east-1|us-east-2|us-west-1|us-west-2|ap-south-1|ap-northeast-1|ap-northeast-2|ap-southeast-1|ap-southeast-
2|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1|sa-east-1
[default: all] Only update security groups in a specific region(s)
-s, --state=pending|running|stopping|stopped|shutting-down|terminated
[default: all] Only get instances of in a specific state(s)
DESCRIPTION
Gathers up to date EC2 instance data and displays summaries in a table
See code: src\commands\list.js
aep update
Update security groups with your new public IP
USAGE
$ aep update
OPTIONS
-r,
--region=us-east-1|us-east-2|us-west-1|us-west-2|ap-south-1|ap-northeast-1|ap-northeast-2|ap-southeast-1|ap-southeast-
2|ca-central-1|eu-central-1|eu-west-1|eu-west-2|eu-west-3|eu-north-1|sa-east-1
[default: all] Only update security groups in a specific region(s)
DESCRIPTION
Checks if your public IP has changed and updates relevant AWS security groups
See code: src\commands\update.js