Skip to content

Setting Up OctoTrack

Installation

pip install octotrack

Requires Python 3.13+.

Setup the OctoTrack Config

Run the OctoTrack setup command

octotrack setup

This sets up all the important files for OctoTrack.

If you ever decide to uninstall octotrack, or you think the configuration is messed up, you can run these two commands.

octotrack setup remove # Remove the OctoTrack Setup
octotrack setup validate # Validate the current OctoTrack setup

Setup your token

Before you can use OctoTrack, you need to set your GitHub Auth Token.

View Get a GitHub Auth Token to setup a token and add it to OctoTrack.