> ## Documentation Index
> Fetch the complete documentation index at: https://hitspec.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Install hitspec — Homebrew, Go, and binary

> Install hitspec on macOS, Linux, or Windows via Homebrew, go install, a pre-built binary, or build from source. Get the hitspec CLI running in minutes.

## Homebrew (macOS / Linux)

hitspec is published as a Homebrew cask in the `abdul-hamid-achik/tap` tap:

```bash theme={null}
brew install --cask abdul-hamid-achik/tap/hitspec
```

This installs the latest release and makes the `hitspec` command available in your shell.

## Go Install

If you have Go installed:

```bash theme={null}
go install github.com/abdul-hamid-achik/hitspec/apps/cli@latest
```

<Note>
  Requires Go 1.25 or later. The binary will be placed in your `$GOPATH/bin` directory -- make sure it's in your `PATH`.
</Note>

## Binary Download

Pre-built archives for every platform are attached to each [GitHub
Release](https://github.com/abdul-hamid-achik/hitspec/releases). Assets are named:

```
hitspec_<version>_<os>_<arch>.tar.gz     # macOS / Linux  (e.g. hitspec_2.14.1_darwin_arm64.tar.gz)
hitspec_<version>_windows_<arch>.zip     # Windows
```

where `<os>` is `darwin`, `linux`, or `windows` and `<arch>` is `amd64` or `arm64`.

<Tabs>
  <Tab title="macOS / Linux">
    Download the archive for your platform from the
    [Releases page](https://github.com/abdul-hamid-achik/hitspec/releases/latest),
    then extract and install it. For example, on Apple Silicon macOS:

    ```bash theme={null}
    # Substitute the version and platform for your machine
    VERSION=2.19.0
    curl -Lo hitspec.tar.gz \
      "https://github.com/abdul-hamid-achik/hitspec/releases/download/v${VERSION}/hitspec_${VERSION}_darwin_arm64.tar.gz"
    tar -xzf hitspec.tar.gz hitspec
    chmod +x hitspec
    sudo mv hitspec /usr/local/bin/
    ```
  </Tab>

  <Tab title="Windows">
    Download `hitspec_<version>_windows_amd64.zip` from the
    [Releases page](https://github.com/abdul-hamid-achik/hitspec/releases/latest),
    extract `hitspec.exe`, and add its folder to your `PATH`.
  </Tab>
</Tabs>

<Tip>
  Homebrew (`brew install --cask abdul-hamid-achik/tap/hitspec`) and `go install` keep
  hitspec up to date automatically -- prefer them over manual downloads unless you
  need a specific archived version.
</Tip>

## Build from Source

To build hitspec yourself -- to contribute, or to get an unreleased change -- clone
the repo and build the CLI. The module is `github.com/abdul-hamid-achik/hitspec`
and the CLI entry point is `apps/cli`.

<Steps>
  <Step title="Prerequisites">
    * **Go 1.25+** (`go version`)
    * **[Task](https://taskfile.dev)** -- the task runner used for every dev command (optional, but recommended)
    * **[glyph](https://github.com/abdul-hamid-achik/glyphrun)** -- only needed to run the studio end-to-end specs (`task e2e`)
  </Step>

  <Step title="Clone and build">
    <CodeGroup>
      ```bash With Task (recommended) theme={null}
      git clone https://github.com/abdul-hamid-achik/hitspec.git
      cd hitspec
      task setup   # download deps + run code generation
      task build   # builds ./bin/hitspec
      ```

      ```bash Plain Go theme={null}
      git clone https://github.com/abdul-hamid-achik/hitspec.git
      cd hitspec
      go build -o bin/hitspec ./apps/cli
      ```
    </CodeGroup>

    `task build` stamps the binary with the version and build time. The result is
    `./bin/hitspec`.
  </Step>

  <Step title="Install to your PATH (optional)">
    ```bash theme={null}
    task install   # go install into $GOPATH/bin
    ```
  </Step>

  <Step title="Run the checks">
    ```bash theme={null}
    task test    # all Go tests (race + coverage)
    task lint    # gofmt + go vet + golangci-lint
    task check   # lint + test + security
    task e2e     # studio terminal-UI specs (requires glyph)
    ```
  </Step>
</Steps>

<Note>
  Run `task` (or `task --list`) to see every available command, including
  `task studio:dev`, `task serve:dev`, and `task docs:dev` (live Mintlify docs).
</Note>

## Verify Installation

```bash theme={null}
hitspec version
```

You should see the installed version number. If the command is not found, make sure the binary location is in your `PATH`.

## Updating

<CodeGroup>
  ```bash Homebrew theme={null}
  brew upgrade --cask hitspec
  ```

  ```bash Go theme={null}
  go install github.com/abdul-hamid-achik/hitspec/apps/cli@latest
  ```
</CodeGroup>