> For the complete documentation index, see [llms.txt](https://canine.gitbook.io/canine.sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://canine.gitbook.io/canine.sh/getting-started/quickstart/optional-install-canine-locally.md).

# (Optional) Install Canine locally

{% hint style="success" %}
If you're using the [cloud version](https://canine.sh) of Canine, you can skip this.
{% endhint %}

Make sure you have docker compose installed on your local machine before continuing. Make sure you can run `docker compose` successfully before continuing.

Canine can be installed locally by running

```bash
curl -sSL https://raw.githubusercontent.com/czhu12/canine/refs/heads/main/install/install.sh | bash
```

Navigate to <http://localhost:3456> and you should see a welcome page, and a prompt to add your Github token.

Go to your Github profile's [tokens page](https://github.com/settings/tokens), and click **Generate new token (classic).** Give your token a name and make sure to select the permissions **`repo`**, **`write:packages`**, and **`delete:packages`**

<figure><img src="https://3772676851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fmv8lGansHqECmhIqdMwm%2Fuploads%2FQ01vyCDaxdZgXYD6cyUB%2Fimage.png?alt=media&amp;token=7db36453-c984-409e-826b-9ebfe75a25ec" alt=""><figcaption></figcaption></figure>

Copy the token into your local Canine instance, and you're good to go!