| Name | aec-cli JSON |
| Version |
3.1.0
JSON |
| download |
| home_page | |
| Summary | AWS EC2 CLI |
| upload_time | 2024-02-21 02:12:11 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2019 SEEK Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
aws
ec2
command line
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AWS EC2 CLI
[](https://github.com/seek-oss/aec/actions/workflows/ci.yml)
[](https://github.com/seek-oss/aec/actions/workflows/release.yml)
[](https://pypi.org/project/aec-cli/)
_"Instead of using the console, use the cli!"_.
Command-line tools for managing pet EC2 instances by name.
Defaults only need to be supplied once via a [config file](src/aec/config-example/ec2.toml), which supports multiple profiles for different regions or AWS accounts.
For examples see:
- [EC2](docs/ec2.md) - manipulate EC2 instances by name, and launch them with tags and EBS volumes of any size, as per the settings in the configuration file (subnet, security group etc).
- [AMI](docs/ami.md) - describe, delete and share images
- [Compute Optimizer](docs/compute-optimizer.md) - show over-provisioned instances
- [SSM](docs/ssm.md) - run commands on instances, and [ssm patch management](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-patch.html)
## Prerequisites
- python 3.8+
## Install
Run the following to install the latest master version using pip:
```
pip install aec-cli
```
If you have previously installed aec, run the following to upgrade to the latest version:
```
pip install --upgrade aec-cli
```
NB: Consider using [pipx](https://github.com/pipxproject/pipx) to install aec-cli into its own isolated virtualenv.
## Configure
Before you can use aec, you will need to create the config files in `~/.aec/`. The config files contain settings for your AWS account including VPC details and additional tagging requirements.
To get started, run `aec configure example` to install the [example config files](src/aec/config-example/) and then update them as needed.
## Handy aliases
For even faster access to aec subcommands, you may like to add the following aliases to your .bashrc:
```
alias ec2='COLUMNS=$COLUMNS aec ec2'
alias ami='COLUMNS=$COLUMNS aec ami'
alias ssm='COLUMNS=$COLUMNS aec ssm'
```
`COLUMNS=$COLUMNS` will ensure output is formatted to the width of your terminal when piped.
## FAQ
### How do I use aec with other AWS profiles?
To use aec with the named profile 'production':
```
export AWS_DEFAULT_PROFILE=production
aec ec2 describe
```
## Similar projects
[wallix/awless](https://github.com/wallix/awless) is written in Go, and is an excellent substitute for awscli with
support for many AWS services. It has human friendly commands for use on the command line or in templates. Unlike `aec` its ec2 create instance command doesn't allow you to specify the EBS volume size, or add tags.
[achiku/jungle](https://github.com/achiku/jungle) is written in Python, and incorporates a smaller subset of ec2 commands and doesn't launch new instances. It does however have an ec2 ssh command. It also supports other AWS services like ELB, EMR, RDS.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) to get started and develop in this repo.
Raw data
{
"_id": null,
"home_page": "",
"name": "aec-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "AWS,EC2,command line,cli",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/2a/89/f5ca230ccd3c913dbf1f03efa81a9aece63879fd748575cbd852cf3b9553/aec-cli-3.1.0.tar.gz",
"platform": null,
"description": "# AWS EC2 CLI\n\n[](https://github.com/seek-oss/aec/actions/workflows/ci.yml)\n[](https://github.com/seek-oss/aec/actions/workflows/release.yml)\n[](https://pypi.org/project/aec-cli/)\n\n_\"Instead of using the console, use the cli!\"_.\n\nCommand-line tools for managing pet EC2 instances by name.\n\nDefaults only need to be supplied once via a [config file](src/aec/config-example/ec2.toml), which supports multiple profiles for different regions or AWS accounts.\n\nFor examples see:\n\n- [EC2](docs/ec2.md) - manipulate EC2 instances by name, and launch them with tags and EBS volumes of any size, as per the settings in the configuration file (subnet, security group etc).\n- [AMI](docs/ami.md) - describe, delete and share images\n- [Compute Optimizer](docs/compute-optimizer.md) - show over-provisioned instances\n- [SSM](docs/ssm.md) - run commands on instances, and [ssm patch management](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-patch.html)\n\n## Prerequisites\n\n- python 3.8+\n\n## Install\n\nRun the following to install the latest master version using pip:\n\n```\npip install aec-cli\n```\n\nIf you have previously installed aec, run the following to upgrade to the latest version:\n\n```\npip install --upgrade aec-cli\n```\n\nNB: Consider using [pipx](https://github.com/pipxproject/pipx) to install aec-cli into its own isolated virtualenv.\n\n## Configure\n\nBefore you can use aec, you will need to create the config files in `~/.aec/`. The config files contain settings for your AWS account including VPC details and additional tagging requirements.\n\nTo get started, run `aec configure example` to install the [example config files](src/aec/config-example/) and then update them as needed.\n\n## Handy aliases\n\nFor even faster access to aec subcommands, you may like to add the following aliases to your .bashrc:\n\n```\nalias ec2='COLUMNS=$COLUMNS aec ec2'\nalias ami='COLUMNS=$COLUMNS aec ami'\nalias ssm='COLUMNS=$COLUMNS aec ssm'\n```\n\n`COLUMNS=$COLUMNS` will ensure output is formatted to the width of your terminal when piped.\n\n## FAQ\n\n### How do I use aec with other AWS profiles?\n\nTo use aec with the named profile 'production':\n\n```\nexport AWS_DEFAULT_PROFILE=production\naec ec2 describe\n```\n\n## Similar projects\n\n[wallix/awless](https://github.com/wallix/awless) is written in Go, and is an excellent substitute for awscli with\nsupport for many AWS services. It has human friendly commands for use on the command line or in templates. Unlike `aec` its ec2 create instance command doesn't allow you to specify the EBS volume size, or add tags.\n\n[achiku/jungle](https://github.com/achiku/jungle) is written in Python, and incorporates a smaller subset of ec2 commands and doesn't launch new instances. It does however have an ec2 ssh command. It also supports other AWS services like ELB, EMR, RDS.\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) to get started and develop in this repo.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019 SEEK Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "AWS EC2 CLI",
"version": "3.1.0",
"project_urls": {
"homepage": "https://github.com/seek-oss/aec"
},
"split_keywords": [
"aws",
"ec2",
"command line",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53862c41984aa2c6ac9a39558e03d9f88e86c26b4bb3fdb2a52804dc4e5ce8aa",
"md5": "3795debb7800d37a7063b7ef12f3234d",
"sha256": "6715db3d287a6f29394037c0394690317ce6a1f3c03fa12458d10d3ebe3b9d7a"
},
"downloads": -1,
"filename": "aec_cli-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3795debb7800d37a7063b7ef12f3234d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 28290,
"upload_time": "2024-02-21T02:12:09",
"upload_time_iso_8601": "2024-02-21T02:12:09.781756Z",
"url": "https://files.pythonhosted.org/packages/53/86/2c41984aa2c6ac9a39558e03d9f88e86c26b4bb3fdb2a52804dc4e5ce8aa/aec_cli-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a89f5ca230ccd3c913dbf1f03efa81a9aece63879fd748575cbd852cf3b9553",
"md5": "9c8e9740324cc60b4e2b9b2e17875d90",
"sha256": "a22eb972d7a2b6fd2ffa799a8af1d6b1a8b2ffafc64e510c1153678311df5799"
},
"downloads": -1,
"filename": "aec-cli-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "9c8e9740324cc60b4e2b9b2e17875d90",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 39769,
"upload_time": "2024-02-21T02:12:11",
"upload_time_iso_8601": "2024-02-21T02:12:11.620817Z",
"url": "https://files.pythonhosted.org/packages/2a/89/f5ca230ccd3c913dbf1f03efa81a9aece63879fd748575cbd852cf3b9553/aec-cli-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 02:12:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "seek-oss",
"github_project": "aec",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aec-cli"
}
