Skip to main content
The Wrixton CLI is a lightweight Python client that talks to the hosted API at https://projects.wrixton.xyz. Installing it takes about a minute: you clone the repository, run a single setup script, and add one line to your shell config. No server setup is required — the hosted deployment is ready to go the moment you have an API key.

​
Requirements

  • Python 3.11 or newer — init.sh checks for Python 3.11+ automatically and exits with a clear error if none is found. Python 3.12, 3.13, and 3.14 all work.
  • git — to clone the repository.

​
Installation steps

1

Clone the repository

Clone the project-tracker repo from GitHub to any location on your machine:
git clone https://github.com/rwwarren/project-tracker
2

Run the setup script

Change into the cloned directory and run init.sh:
cd project-tracker && ./init.sh
The script does three things automatically:
  1. Detects the highest available Python 3.11+ interpreter on your system.
  2. Creates a virtual environment at project-tracker/.venv and installs the track package into it (editable install, so pulling updates with git pull picks up changes immediately).
  3. Symlinks the track binary from .venv/bin/track to ~/.local/bin/track.
You will see output similar to:
==> creating venv (python3.12)
==> upgrading pip
==> installing track
==> symlinking track → /home/you/.local/bin/track

done. add to your shell config if not already:
  export PATH="$HOME/.local/bin:$PATH"

next: track config   # paste your api_key
3

Add ~/.local/bin to your PATH

If ~/.local/bin is not already on your PATH, add the export to your shell startup file:
export PATH="$HOME/.local/bin:$PATH"
To make this permanent, append the line to your shell config and reload it:
# bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc

# zsh
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc
4

Verify the installation

Confirm the binary is reachable:
track whoami
If the CLI is not yet configured you will see a prompt to run track config. That is expected — the binary is working correctly.

​
Next step: configure your API key

After the binary is on your path, run: 
track config
This prompts you for your API key (input is hidden) and writes the config file to ~/.track/config.toml. See Configuration for the full details, including environment variable overrides and how to point the CLI at a different deployment.
The CLI points at https://projects.wrixton.xyz by default, so you do not need to run or deploy a server of your own. All you need is an API key from the project owner.