Install on macOS

Before you start

• A pairing code or pairing command from the Agents page (ask an admin for it).
• Network access from this machine to your database server.
• A read-only database login, if you already have one — otherwise the setup can generate a script for your DBA to create one.

Install

1. Download and unzip nia-agent-macos-arm64-<version>.zip from the downloads page.
2. Open Terminal in the unzipped folder and run ./install.sh.
3. When it asks "Run guided setup now? [Y/n]", press Enter and answer its questions below.

That's it. The agent runs under your own macOS user account (no administrator rights needed), starts immediately, and restarts itself at login or if it ever stops unexpectedly.

Running an unsigned build

Gatekeeper will say "nia-agent" cannot be opened because the developer cannot be verified. To run it anyway: open System Settings → Privacy & Security after the first blocked attempt and click Open Anyway, or run this once before installing:

xattr -d com.apple.quarantine ./nia-agent

Guided setup questions

1. Pairing command or code — paste the full command from the Agents page, or just the code.
2. Database server (default localhost) and port (default 1433).
3. Database username — leave blank if you don't have one yet, and it offers to write a read-only setup script for your DBA instead.
4. Database password (hidden as you type).
5. Pick a database from a numbered list of what that login can see.
6. Time zone the database server runs in (defaults to this machine's own).
7. Destination hostname to allow (optional — only needed if a job will be published from a Nia Core workflow rather than added directly on this machine).

It then confirms a successful check-in and prints a summary. Run nia-agent setup again any time — once already set up, it shows a small menu instead.

Verify it worked

Open the Agents page on Nia Core — the agent should show up as online within a few seconds. On the machine itself, run nia-agent status.

Uninstall

./uninstall.sh

Add --purge to also remove stored configuration and logs.

Advanced: typed-command install

Install without the guided setup with ./install.sh (or sudo ./install.sh --system for a system-wide service for all users, starting at boot) — it starts immediately either way. Then, in order:

nia-agent sql readonly --login nia_agent --databases <your-database-name> --out nia-readonly-setup.sql

nia-agent pair --code <pairing-code> --url <platform-address>

nia-agent connection add \
  --id <short-id> --label "<friendly name>" \
  --host <database-server-host> --port <port> --database <database-name> \
  --user nia_agent --password <the-password> \
  --source-timezone <IANA time zone, e.g. America/New_York>

nia-agent destinations allow <destination-hostname>

nia-agent status