Skip to content

Installation

pipx install grok-build-cli-utilities

pipx gives you an isolated environment and puts grok-utils directly on your PATH. Ideal for CLI tools.

pip (global or virtualenv)

pip install grok-build-cli-utilities

From source (development / latest)

git clone https://github.com/cobusgreyling/grok-build-cli-utilities.git
cd grok-build-cli-utilities
pip install -e ".[dev]"

After editable install you can run grok-utils (ensure the Python user scripts dir or venv bin is on PATH).

You can also run directly:

python -m pip install -e ".[dev]"
python -m grok_build_cli_utilities --help   # or use the entrypoint

Verify

grok-utils --version
grok-utils --help
grok-utils doctor

Using with a non-default Grok home

All commands support:

grok-utils --grok-home /path/to/.grok ...
# or
GROK_HOME=/path/to/.grok grok-utils ...

Updating

pipx upgrade grok-build-cli-utilities
# or
pip install --upgrade grok-build-cli-utilities

Optional: docs extras (for contributors)

pip install -e ".[docs]"
mkdocs serve

See Development for the full workflow.