installation.mdx

title	Install commitdog on Linux, macOS, and Windows
sidebarTitle	Installation
description	Install commitdog on Linux, macOS, and Windows using a one-line curl script, Homebrew, the AUR, or a PowerShell command. Setup takes under a minute.
icon	folder-down

commitdog ships as a single binary with no runtime dependencies. Pick the installation method for your platform below, verify the install, and then move on to setup to configure your platform token.

Run the install script with curl. It detects your architecture (amd64 or arm64), downloads the correct binary from the latest GitHub release, and installs it to `/usr/local/bin`.

```bash
curl -fsSL https://aysdog.com/install-commitdog.sh | sh
```

If you are on **Arch Linux**, you can install from the AUR instead:

```bash
yay -S commitdog-bin
```

You have two options on macOS: the curl script or Homebrew.

<CodeGroup>

```bash curl (recommended)
curl -fsSL https://aysdog.com/install-commitdog.sh | sh
```

```bash Homebrew
brew tap aysdog/commitdog && brew install commitdog
```

</CodeGroup>

The curl script works on both Intel (amd64) and Apple Silicon (arm64) Macs. Homebrew keeps commitdog up to date alongside your other packages.

Run the following command in a PowerShell terminal. It downloads and installs the commitdog binary for Windows (amd64).

```powershell
irm https://aysdog.com/install-commitdog.ps1 | iex
```

Verify the installation

After installing, confirm that commitdog is on your PATH:

commitdog --version

You should see the version number printed to your terminal.

Next step

Once commitdog is installed, run commitdog setup to configure your email and platform token. See Setup for instructions.

---

The recommended way to remove commitdog is the built-in uninstall command:

commitdog --uninstall

The command asks for confirmation, then removes the commitdog binary and its config directory from your machine. On Linux and macOS, it prompts for sudo if the binary requires elevated permissions to delete. If any step fails, commitdog prints the exact manual command to run instead.

If the binary is already gone or you prefer to remove everything by hand, run the commands for your platform:

```bash rm $(which commitdog) && rm -rf ~/.config/commitdog ``` ```powershell Remove-Item "$env:USERPROFILE\AppData\Local\commitdog.exe" Remove-Item -Recurse "$env:APPDATA\commitdog" ```