Nexus Tools
Useful CLI tool for running our docker-compose stacks, code quality and other development tools.
Install
To install the nexus development tools, run the following one-line command:
wget -O - https://registry.nexusmods.com/public/nexus-tools/-/raw/ruby-3.2/install.sh | bashManual Install
To install the tools manually, run.sh from this repo needs to be placed somewhere on your machine, allowed to be executed and your .bashrc file needs updating with the following alias:
alias nexus="~/nexus-tools/nexus-tools.sh"Usage
To run the tools, the nexus command is used:
~$ nexus -h
Nexus Mods Development Tools
commands:
down Stops a docker-compose service
up Starts a docker-compose service in the background
build Builds the local image(s) for a docker-compose service. Allows docker-compose build arguments
restart Stops and then starts a docker-compose service
rebuild Stops, builds and then starts a docker-compose service
logs Shows the logs for a docker-compose service
cq, code-quality Runs the nexus code quality tool
gu, gemfile-updater Runs the gemfile updater tool, outputting common gemfiles in the console
bu, bundle-update Mounts the Gemfile and lockfile and runs bundle update.
update Updates this script to the latest version.
-h, --help show brief help
options:
--logs Can be appended to up, restart or rebuild to tail the logs for the docker-compose serviceUninstalling tool
If the tool was installed automatically, the script can be deleted from ~/nexus-tools, and the .bashrc file can be updated to remove the nexus alias.