Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prx/homebrew-dev-tools


https://github.com/prx/homebrew-dev-tools

Last synced: 16 days ago
JSON representation

Awesome Lists containing this project

README

        

# Install

```
brew tap prx/dev-tools
brew install prx-dev-tools
```

# Configuration

You can optionally configure these scripts to use certain AWS profiles and dev tools:

```sh
echo "export PRX_SSH_KEY=~/.ssh/id_ed25519_prx_developer" >> ~/.bash_profile
echo "export PRX_AWS_PROFILE=prx-default" >> ~/.bash_profile
```

# Scripts

## awssh

The `awssh` command allows you to ssh into a running EC2 instance or ECS task.
You can get a shell on the host EC2, a shell inside the running Docker container,
or even attach to a Rails/Elixir/etc console.

## awstunnel

Our production databases are all in a private VPC, inaccessible from the public
internet. To gain access locally, use the `awstunnel` script which tunnels some
local high port numbers through our jump servers, to the staging/production db
servers.

## prxameter-get

Used to get all the parameter-store keys/values underneath a slash-separated-path,
in dotenv format. By default, writes to a well-named file that can be re-saved
to parameter-store by `prxameter-set`.

## prxameter-set

Passing in a filename output by `prxameter-get`, writes any changes back to
parameter-store. By default, does a dry-run previewing the changes unless you
pass the `--commit` flag.

# Contribute

After you've made your changes and committed them to the main branch, create a new release in GitHub, with a new version tag (in the format `v1.2.3`). Once the release has been created, a GitHub action will automatically update the formula file to match the newly-released version and update the SHA 256 hash.

This does mean that any given release will actually include the formula file for the _previous_ version. This does not matter.