Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@dwmkerr/boxes

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@dwmkerr/boxes

Quick access to your cloud instances.

  • 0.1.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2
Maintainers
1
Weekly downloads
 
Created
Source

boxes

main codecov

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.

TODO demo recording

Quickstart

Tag any AWS instance you want to control with a tag named boxes.boxid:

TODO smaller screenshot

Screenshot: The AWS EC2 Instances console showing two boxes and the boxid tag

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:

Screen recording: TODO

Developer Guide

Clone the repo, install dependencies, link, then the boxes command will be available:

git clone git@github.com:dwmkerr/boxes.git
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

The recording at the top of the README file is an SVG based on an asciinema recording that has been converted to SVG with svg-term-cli.

To update the recording:

  1. Install asciinema brew install asciinema

To record a Tmux session, you will need to start detached from Tmux and then attach. You can do this by hand, simply using tmux attach, but this adds some noise to the beginning of the recording. A better way is to use the command below:

asciinema rec --command "tmux attach [-t session-name]"

## TODO

Quick and dirty task-list.

- [ ] npm badge download link
- [ ] screen recording of boxes list / stop / start / connect
- [ ] document how 'connect' works
- [ ] build / lint / test / deploy pipeline
- [ ] add support for OpenVPN server to save $10/month
- [ ] torrent box is not mounting larger volume for storage
- [ ] Cost management tags configuration to allow pricing info
- [ ] docs: make AWS screenshot a bit smaller in readme
- [ ] docs: create and share blogpost

FAQs

Package last updated on 08 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc