Skip to main content

HiAUDIT Documentation

/
  • Dashboard
  • Dashboard

Search

Close search
Open search
Menu
  • Getting Started

    • Getting Started

    • Log in to HiAUDIT
    • Generate an API Key
    • Install the HiAUDIT Agent
    • Connect to your IDE
    • Run your first audit
  • Reference

    • Reference

    • Command Line Interface
    • MCP Tools
    • Project Detection
    • Skill Playbooks
    • Supported Languages
  • Usage

    • Usage

    • Smart contract auditing
    • Web application auditing
    • Update
    • Troubleshooting
  1. HiAUDIT Documentation
  2. Getting Started
  3. Install the HiAUDIT Agent

Install the HiAUDIT Agent

Install the HiAUDIT Agent with a one-line command tailored to your platform.

Edit this page

© 2026 GitHub, Inc. All rights reserved.

The Installation page in the dashboard provides a one-command installer tailored to your platform. The page auto-detects your OS and embeds your selected API key.

Watch: copy your key and run the installer

This short walkthrough shows how to copy your API key from the dashboard and run the install command in your terminal.

Your browser does not support the video tag.

Quick install

Replace <YOUR_API_KEY> with the key you created in the previous step.

macOS / Linux

curl -sSL https://app.hiaudit.io/install.sh | bash -s -- <YOUR_API_KEY>

Windows (PowerShell)

$env:HIAUDIT_KEY="<YOUR_API_KEY>"; irm https://app.hiaudit.io/install.ps1 | iex

What the installer does

  1. Detects your OS and CPU architecture automatically.
  2. Downloads the correct pre-built binary for your platform.
  3. Installs the binary to a directory in your PATH.
  4. Activates the agent with your API key.
  5. Copies supporting files (skills, MCP config) to your home directory.

Verify the installation

hiauditagent --help

If the help text prints, the agent is installed correctly.

macOS: binary blocked by Gatekeeper

If macOS shows a “cannot be opened” or “unverified developer” error after installation, run these two commands once to clear quarantine attributes and ad-hoc sign the binary:

sudo xattr -cr /usr/local/bin/hiauditagent sudo codesign --force --sign - /usr/local/bin/hiauditagent

Next step

Now connect HiAUDIT to your IDE.

On this page

  • Watch: copy your key and run the installer
  • Quick install
  • What the installer does
  • Verify the installation
  • macOS: binary blocked by Gatekeeper
  • Next step