{"id":15684567,"url":"https://github.com/robertpeteuil/aws-quick-cli","last_synced_at":"2025-05-07T16:12:29.904Z","repository":{"id":130532266,"uuid":"84755049","full_name":"robertpeteuil/aws-quick-cli","owner":"robertpeteuil","description":"Control AWS EC2 instances using only their name (forget about Instance-Id's forever).  Examples: aws-ssh NAME (connect via ssh), aws-list, aws-start NAME, aws-stop NAME","archived":false,"fork":false,"pushed_at":"2018-01-25T23:08:45.000Z","size":76,"stargazers_count":10,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-07T16:12:21.602Z","etag":null,"topics":["aws","aws-cli","aws-cli-utilities","aws-console","aws-manage","aws-shell","aws-ssh","cli","ec2-instance","ssh","ssh-config"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robertpeteuil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-12T20:27:46.000Z","updated_at":"2022-12-21T18:36:20.000Z","dependencies_parsed_at":"2023-04-14T07:57:44.029Z","dependency_job_id":null,"html_url":"https://github.com/robertpeteuil/aws-quick-cli","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertpeteuil%2Faws-quick-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertpeteuil%2Faws-quick-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertpeteuil%2Faws-quick-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertpeteuil%2Faws-quick-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertpeteuil","download_url":"https://codeload.github.com/robertpeteuil/aws-quick-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252912997,"owners_count":21824066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-cli","aws-cli-utilities","aws-console","aws-manage","aws-shell","aws-ssh","cli","ec2-instance","ssh","ssh-config"],"created_at":"2024-10-03T17:19:19.015Z","updated_at":"2025-05-07T16:12:29.884Z","avatar_url":"https://github.com/robertpeteuil.png","language":"Shell","readme":"# AWS Quick CLI\n### Easily control and ssh to AWS instances using their Name\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a7b3d53ab89a4b758766c238173175cc)](https://www.codacy.com/app/robertpeteuil/aws-quick-cli?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=robertpeteuil/aws-quick-cli\u0026amp;utm_campaign=Badge_Grade)\n[![GitHub issues](https://img.shields.io/github/issues/robertpeteuil/aws-quick-cli.svg)](https://github.com/robertpeteuil/aws-quick-cli)\n[![GitHub release](https://img.shields.io/github/release/robertpeteuil/aws-quick-cli.svg?colorB=1c64bf)](https://github.com/robertpeteuil/aws-quick-cli)\n[![lang](https://img.shields.io/badge/language-bash-89e051.svg?style=flat-square)](https://github.com/robertpeteuil/aws-quick-cli)\n[![license](https://img.shields.io/github/license/robertpeteuil/aws-quick-cli.svg?colorB=1c64bf)](https://github.com/robertpeteuil/aws-quick-cli)\n\n---\n\nAWS Quick CLI allows listing, starting, stopping and connecting to instances by name or instance-id.\n\n### Example of `aws-list` sub-utility:\n![](https://cloud.githubusercontent.com/assets/1554603/24174034/db095af6-0e4b-11e7-8e66-fdfa1d8eecae.png)\n\n### Overview:\n\nThis utility suite consists of four utilities: `aws-list`, `aws-start`, `aws-stop`, and `aws-ssh`.\n\n- SSH to an Instance: `aws-ssh NAME` or `aws-ssh -i ID`\n\n  - Additional parameters described in Details\n\n- List Instances: `aws-list`\n\n  - Additional parameters described in Details\n\n- Start Instance: `aws-start NAME` or `aws-start -i ID`\n- Stop Instance: `aws-stop NAME` or `aws-stop -i ID`\n\n### Details\n\n- SSH to Instance: `aws-ssh NAME` or `aws-ssh -i ID`\n\n  - automatically calculates login-name based on the image-type of the instance\n  - override the calculated login-name `-u USERNAME`\n  - connect without PEM keys (if properly configured) `-p`\n  - command specific help `aws-ssh -h`\n\n- List Instances: `aws-list`\n\n  - list all instances (default).\n  - list running instances `-r` or `--running`\n  - list stopped instances `-s` or `--stopped`\n  - list instances with specified name `aws-list NAME`\n  - list instance with specified instance-id `aws-list -i ID`\n  - command specific help `aws-list -h`\n\n- Start Instance: `aws-start NAME` or `aws-start -i ID`\n\n  - start instance by name or instance-id\n  - command specific help `aws-start -h`\n\n- Stop Instance: `aws-stop NAME` or `aws-stop -i ID`\n\n  - start instance by name or instance-id\n  - command specific help `aws-stop -h`\n\n\n### Supported Platforms:\n\n- Linux\n- macOS (OS X)\n- Windows 10 'Bash on Windows'\n\n### Pre-Requisites:\n\n- The AWS CLI utilities must installed and configured\n  - **Do not install the AWS CLI via a package manager** - this usually installs an outdated version which will not work with these utilities.\n- Instructions for installing the AWS-CLI utilities are included at the bottom of this README in the section *Reference - Installation of AWS-CLI* and or on the [AWS Website](http://docs.aws.amazon.com/cli/latest/userguide/installing.html).\n\n## Installation:\n\nThe utilities in the repo can be installed with curl\n\n```shell\nbash -c \"`curl -s -L https://raw.github.com/robertpeteuil/aws-quick-cli/master/install.sh`\"\n```\n\nIf the repo has been downloaded locally, cd into the directory and run install.sh\n\n```shell\ncd aws-quick-cli\n./install.sh\n```\n\n### Reference - Installation of AWS-CLI\n\n##### Pre-Requisites:\n\n- Installation requires Python 2 version 2.6.5+ or Python 3 version 3.3+\n- Installation requires the `unzip` command, which can be installed by typing `sudo apt-get install unzip`\n- **Do not install the AWS CLI via a package manager** - this may install an outdated version that's incompatible with these utilities.\n- For help or additional instruction see the [AWS Website](http://docs.aws.amazon.com/cli/latest/userguide/installing.html)\n\n#### Installation with `sudo` capabilities:\n\n```shell\n$ cd ~\n$ mkdir tmpawsinstall\n$ cd tmpawsinstall\n$ curl \"https://s3.amazonaws.com/aws-cli/awscli-bundle.zip\" -o \"awscli-bundle.zip\"\n$ unzip awscli-bundle.zip\n$ sudo ./awscli-bundle/install -i /usr/local/aws -b /usr/local/bin/aws\n$ cd ..\n$ rm -rf tmpawsinstall\n```\n\n#### Installation without `sudo` capabilities:\n\n```shell\n$ cd ~\n$ mkdir tmpawsinstall\n$ cd tmpawsinstall\n$ curl \"https://s3.amazonaws.com/aws-cli/awscli-bundle.zip\" -o \"awscli-bundle.zip\"\n$ unzip awscli-bundle.zip\n$ ./awscli-bundle/install -b ~/bin/aws\n$ cd ..\n$ rm -rf tmpawsinstall\n```\n\nAdditional steps for non-sudo installations:\n\n- manually add the `~/bin` directory to your PATH\n- This is performed by editing your shell profile\n  - This file is either `~/.profile`, `~/.bash_profile` or `~/.bash_rc` depending on your OS.\n\n#### Configure the AWS CLI utilities\n\n- Configuration requires using your AWS Access Key ID # and AWS Secret Access Key and running the command: `aws configure`\n- If you don't have these, refer to the [AWS getting started page](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html)\n- Check here for more information on [configuring the AWS-CLI](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-quick-configuration)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertpeteuil%2Faws-quick-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertpeteuil%2Faws-quick-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertpeteuil%2Faws-quick-cli/lists"}