Render Engine CLI is the CLI tool for the Render Engine static site generator. Please refer to the main CONTRIBUTING.md for more details on how to contribute.
Render Engine CLI is a uv based project. For more information on installing uv and using it
please see the uv documentation. To get started, for
this repository and check out your fork.
git clone <url to fork>Once you have checked out the repository, run uv sync and then activate the venv that was
created:
uv sync
source .venv/bin/activateOnce you have done this you will be in the virtual environment and ready to work. It is recommended that you do a local, editable install of the CLI in your virtual environment so that you can easily work with the changes you have made.
uv pip install . && uv pip install -e .NOTE: The above actually has you installing the CLI as uneditable and then as editable. This
is only needed as long as the main Render Engine install includes an entry point as there is a
conflict. The uv pip install . will overwrite the entry point for render-engine while the
second command, uv pip install -e . will convert it to an editable install.
This will allow you to test your changes via the command line.