Developer Setup

This page is the starting point for engineers who need to clone the repository, inspect the CLI code, run tests, and update documentation alongside code changes.

Clone The Repository

git clone <repo-url>
cd gen5-deploy

If you are working on the packaged CLI, most day-to-day work happens under deploy/.

Create A Virtual Environment

From the repository root:

python3 -m venv .venv
source .venv/bin/activate

Install The Deploy Package For Local Development

cd deploy
python3 -m pip install --upgrade pip
python3 -m pip install -e .
python3 -m pip install -r requirements-dev.txt

This gives you local slservice and sladmin entry points while keeping the code editable in place.

Run Basic Checks

The repository currently includes tests under deploy/tests/.

cd deploy
pytest

You can also inspect CLI behavior directly:

python3 slservice_cli.py --help
python3 sladmin_cli.py --help

Developer Workflow

For most changes:

  1. Update code under deploy/ or the relevant script location.
  2. Update the corresponding documentation in docs/.
  3. If flags or help text change, regenerate the CLI docs.
  4. Run tests that cover the changed behavior.

Regenerate CLI Reference Pages

From the repository root:

python3 scripts/generate_cli_docs.py

This command refreshes:

  • docs/cli/slservice.md
  • docs/cli/sladmin.md

The generator pulls directly from live --help output so the docs stay aligned with the current parser definitions.