logcrux / install

home install usage formats how it works config troubleshooting faq source

install

$ pip install logcrux
$ logcrux --version

Requires Python ≥3.11. That's the whole install: everything logcrux needs, including its local inference models, ships inside the package. Nothing is downloaded at run time and no network access is required to run it.

shell completion

$ logcrux --install-completion    # installs for your current shell
$ logcrux --show-completion       # prints the completion script

Supports bash, zsh, fish, and PowerShell (via Typer).

upgrading

$ pip install --upgrade logcrux

uninstalling

$ pip uninstall logcrux

logcrux keeps a small local state database for baseline tracking at ~/.local/share/logcrux/state.db (see config). Remove it manually if you want a clean slate:

$ rm -rf ~/.local/share/logcrux

next

Now see usage for the full command reference.