_
| |
_ _ __| | _____ __
| | | |/ _` |/ _ \ \ / /
| |_| | (_| | __/\ V /
| ._,_|\__,_|\___| \_/
| |
|_|
μdev CLI tool to simplify development tasks
See the installation docs
npm remove -g udev
This tool can perform the following commands
box
command to interact with devbox
ℹ️ these actions are in development and may not work or change wihtout notice
up
sets up the devbox environmentdown
tears down the devbox environmentrun
runs a custom devbox commandnuke
erases all devbox ephemeral data
cd
command to change directory to ~/src/github.com/<org>/<repo>
When changing directory to a default org repository, you only need to provide the repo name.
--print
: prints the path instead of changing directory
git clone
command to clone a repository to ~/src/github.com/<org>/<repo>
When cloning a default org repository, you only need to provide the repo name.
--http
: clones using thehttps
url instead ofssh
(e.g.,https://github.com/patsissons/udev.git
)--replace
: first removes any existing cloned repository--verbose
: emits commands being run
dev clone udev
: performs agit clone git@github.com:patsissons/udev.git ~/src/github.com/patsissons/udev
dev clone blocklytics/ethereum-blocks --http
performs agit clone https://github.com/blocklytics/ethereum-blocks ~/src/github.com/blocklytics/ethereum-blocks
Emits help about all commands or specific commands
You can also use -h
or --help
on any specific command to get help about that command
dev help
: shows help about all commandsdev help clone
: shows help about theclone
commanddev clone --help
: shows help about theclone
command (same asdev help clone
)
Simply emits PONG
, this is a good smoke test to make sure the tool is not broken.
Runs repository actions, this is the default action if none is specified.
up
sets up the repositorydown
tears down the repositoryrun
runs a repository custom commandopen
opens the configured repository urlnuke
erases all repository ephemeral data (⚠️ this will revert uncommitted changes⚠️ )
Updates the tool to the latest version
Emits the current version of the tool
pnpm dev
will run the tool fromsrc
pnpm build
will build the tool indist
pnpm start
runs a built tool
- All commands live in
src/commands
as their own file or directory- see
clone
for a good example to template from for a simple command. - see
repo
for a good example to template from for a sub-action based command.
- see
chalk
provides a simple entry point to emitting content with styles from any commandrunCommand
,runCommands
, andrunConditionalCommands
simply executing commands
- use
pnpm run-install
to installdev
from local source- note that you need to commit any changes first as the installation will simulate a clone from your local repository