@dwmkerr/boxes
v0.2.0
Published
Quick access to your cloud instances.
Downloads
3
Readme
boxes
Quickly turn on, turn off, list and connect to your AWS instances. Great for saving costs by running servers in the cloud and starting them only when needed.
Quickstart
Tag any AWS instance you want to control with a tag named boxes.boxid
:
In this screenshot I have two instances tagged, one with the value steambox
(used for gaming) and one with torrentbox
(for fast BitTorrent downloads).
Install the Boxes CLI with:
npm install @dwmkerr/boxes
You can now list your boxes with list
and start or stop them with start
and stop
.
The following commands are available for boxes
:
boxes list
- shows all boxes and their statusboxes start
- starts a boxboxes stop
- stops a boxboxes info
- shows info on a boxboxes connect
- opens a boxboxes ssh
- helps initiate an SSH connection to a box
boxes list
Run boxes list
to show the details of boxes:
$ boxes list
steambox: stopped
Name: Steam Box
torrentbox: running
Name: Torrent Box
DNS: ec2-34-221-110-58.us-west-2.compute.amazonaws.com
IP: 34.221.110.58
boxes start
Run boxes start <id>
to start a box:
$ boxes start steambox
steambox (i-098e8d30d5e399b03): stopped -> pending
boxes stop
Run boxes start <id>
to stop a box:
$ boxes stop steambox
steambox (i-098e8d30d5e399b03): running -> stopping
boxes info
Run boxes info <id>
to show detailed info on a box:
$ boxes info steambox
{
boxId: 'steambox',
instanceId: 'i-098e8d30d5e399b03',
name: 'Steam Box',
status: 'stopping',
instance: {
AmiLaunchIndex: 0,
ImageId: 'ami-0fae5ac34f36d5963',
InstanceId: 'i-098e8d30d5e399b03',
InstanceType: 'g4ad.xlarge',
...
boxes connect
The boxes connect
command can be used to open an interface to a box. For this command to work, you need a boxes.json
file that specifies how to connect. As an example, the following configuration file shows how to connect to a Torrent Box:
{
"boxes": {
"torrentbox": {
"connectUrl": "http://${username}@${host}:9091/transmission/web/",
"username": "dwmkerr"
}
}
}
When you run boxes connect torrentbox
the connectUrl
will be expanded with the actual hostname of the running instance, as well as any other parameters in the configuration file (such as the username). Pass the --open
flag to open the connect URL directly:
% boxes connect --open torrentbox
{
url: 'http://[email protected]:9091/transmission/web/',
username: 'dwmkerr'
}
# the system configured browser will open with the url above...
boxes ssh
The boxes ssh
command can be used to quickly ssh into a box. Provide the ssh command that should be used in the boxes.json
file:
{
"boxes": {
"torrentbox": {
"sshCommand": "ssh -i /Users/dwmkerr/repos/github/dwmkerr/dwmkerr/tf-aws-dwmkerr/dwmkerr_aws_key.pem ec2-user@${host}"
}
}
}
Running boxes ssh torrentbox
will expand the command with the host. You can then copy the output and paste into the shell, or run a new shell with this output directly:
% bash -c "${boxes ssh torrentbox}"
Last login: Thu Nov 9 06:13:09 2023 from 135-180-121-112.fiber.dynamic.sonic.net
...
Developer Guide
Clone the repo, install dependencies, link, then the boxes
command will be available:
git clone [email protected]:dwmkerr/boxes.git
# optionally use the latest node with:
# nvm use --lts
npm install
npm link
# Now run boxes commands such as:
boxes list
# Clean up when you are done...
npm unlink
The CLI uses the current local AWS configuration and will manage any EC2 instances with a tag named boxes.boxid
. The value of the tag is the identifier used to manage the specific box.
AWS Configuration
Boxes will use whatever is the currently set local AWS configuration.
Boxes manages EC2 instances that have a tag with the name boxes.boxid
.
Terminal Recording / asciinema
To create a terminal recording for the documentation:
- Install asciinema
brew install asciinema
- Check that you have your profiles setup as documented in
./scripts/record-demo.sh
- Run the script to start a 'clean' terminal
./scripts/record-demo.sh
- Download your recording, e.g. to
./docs/620124.cast
- Install svg-term-cli
npm install -g svg-term-cli
- Convert to SVG:
svg-term --in ./docs/620124.cast --out docs/democast.svg --window --no-cursor --from=1000
Dependencies
Runtime dependencies are:
@aws-sdk/client-ec2
- AWS APIscolors
- to add colour to console outputcommander
- for quickly scaffold CLI appsopen
- to open browsers / applications cross-platform
Development dependencies:
aws-sdk-client-mock-jest
mocks for the AWS V3 CLI as well as matchers for Jest
Notes on cost allocation
- Set boxid tag with terraform
- Recreate resources
- Wait 24hrs
- Give your user permissions for the reports
- costs 0.01$ per call
TODO
Quick and dirty task-list.
- [x] npm badge download link
- [x] bug: package.json path
- [x] build / lint / test / deploy pipeline
- [x] screen recording of boxes list / stop / start / connect
- [x] document how 'connect' works
- [x] feat: ssh connect
- [x] docs: make AWS screenshot a bit smaller in readme
- [x] feat: some basic tests
- [ ] feat: Cost management tags configuration to allow pricing info TODO check cost allocation report
- [ ] docs: cost allocation tags blog post
- [ ] docs: create and share blogpost
- [ ] testing: recreate steam box with cost allocation tag enabled
Later
- [ ] refactor: extract and test the parameter expansion for 'connect'
- [ ] feat: autocomplete
- [ ] feat: aws profile in config file