Skip to content

Running

Depending on how you installed opsbox, there are a variety of ways to execute it.

If you have a tool install

If you installed through the uv tool pipeline as specified here, you'll want to run opsbox like so:

uvx opsbox ... # uvx is an alias of uv tool run

If you installed through the pipx install pipeline as specified here, you should have opsbox in your path.

opsbox ...

Plugins in your tool environment should be automatically found and availbale for use.

If not, refer back to the installation instructions and find the instructions for your chosen tool, which will tell you how to install packages in your tool environment.

If you have a cloned repo isntall

If you followed the instructions here, you should have a opsbox/main.py file that you will run in your created virtual environment.

You can run in-project using UV like so:

uv run ./opsbox/main.py ... 

Plugins in the projects virtual environment will be automatically found, and local plugins can be pointed to by following the instructions here