{"id":16111318,"url":"https://github.com/bripkens/ec2c.js","last_synced_at":"2025-03-18T09:31:02.542Z","repository":{"id":57219130,"uuid":"46447008","full_name":"bripkens/ec2c.js","owner":"bripkens","description":"Search and connect to EC2 instances via SSH - the easy way.","archived":false,"fork":false,"pushed_at":"2016-06-23T11:17:47.000Z","size":240,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-13T04:02:19.216Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bripkens.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-18T20:57:18.000Z","updated_at":"2022-07-05T19:05:20.000Z","dependencies_parsed_at":"2022-08-29T02:11:59.988Z","dependency_job_id":null,"html_url":"https://github.com/bripkens/ec2c.js","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bripkens%2Fec2c.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bripkens%2Fec2c.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bripkens%2Fec2c.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bripkens%2Fec2c.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bripkens","download_url":"https://codeload.github.com/bripkens/ec2c.js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243911185,"owners_count":20367642,"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":[],"created_at":"2024-10-09T19:41:32.405Z","updated_at":"2025-03-18T09:31:02.222Z","avatar_url":"https://github.com/bripkens.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eec2c\u003c/h1\u003e\n\u003cp align=\"center\"\u003eSearch and connect to EC2 instances via SSH - the easy way.\u003c/p\u003e\n\n[![NPM](https://nodei.co/npm/ec2c.png?downloads=true\u0026downloadRank=true)](https://nodei.co/npm/ec2c/)\n\n## Introduction\nAren't you tired of looking up EC2 instances by name via the AWS console, the AWS CLI tools or custom scripts? Wouldn't it be great to just type in what you are looking for and get a list of EC2 instances that match your query and that you can connect to by hitting *enter*?\n\nThis is what *ec2c* (**ec2 c**onnect) was made for! *ec2c* retrieves a list of all running EC2 instances, applies fuzzy search on that list and makes it easy for you to pick just the instance that you need.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./screenshot.png\"\n       alt=\"Screenshot showing the CLI\"\n       width=\"400px\"\n       align=\"center\"/\u003e\n\u003c/p\u003e\n\n## Installation\nYou will need a recent Node.js version such as Node.js v4 to use *ec2c*. If you have Node.js installed, you can install *ec2c* via the following command.\n\n```\nnpm install -g ec2c\n```\n\n## Usage\n*ec2c* comes with a CLI that can be used via `ec2c`. Just type in `ec2c` and the command prompt will take you from there. *ec2c* uses the [AWS Node.js SDK](https://github.com/aws/aws-sdk-js) which encapsulates authentication with AWS. It does this via the same mechanisms that are supported by the AWS CLI, i.e. it respects the AWS config and environment variables. For configuration instructions check out the documentation of the [AWS SDK](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html).\n\nIt even supports multiple AWS profiles via the `AWS_PROFILE` [environment variable](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Using_Profiles_with_the_SDK).\n\n## Configuration\n*ec2c* currently has limited configuration parameters. It assumes that defaults are what you want.\n\n - **Default User Name**: It is possible to define a default user name. To do so, specify it via an `EC2C_DEFAULT_USER_NAME` environment variable. For example, you could put the following into your `.bashrc`.\n\n```\nexport EC2C_DEFAULT_USER_NAME='ubuntu'\n```\n\n- **Private Key**: If you do not want to store the private key for your EC2 instances in your SSH authentication agent, you can also specify the `EC2C_PRIVATE_KEY` environment variable. For example, you could put the following into your `.bashrc`.\n\n```\nexport EC2C_PRIVATE_KEY=\"$HOME/.ssh/my-private-key-for-ec2-instances.pem\"\n```\n\n- **AWS Key selection**: Use the `AWS_PROFILE` environment variable to select credentials from your AWS config file `$HOME/.aws/credentials`.\n\n```\nexport AWS_PROFILE=\"work\"\n```\n\n- **Cache expiry**: ec2c caches the AWS instance list for five minutes. This caching is not always desirable, especially when starting up new instances. Use the environment variable `EC2C_CACHE_EXPIRY` to define the cache expiry in milliseconds.\n\n```sh\n# disable ec2c cache\nexport EC2C_CACHE_EXPIRY='0'\n```\n\n## License (MIT)\n\nCopyright (c) 2015 Ben Ripkens\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbripkens%2Fec2c.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbripkens%2Fec2c.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbripkens%2Fec2c.js/lists"}