Getting Started

Installation

macOS & Linux (via Homebrew)

The standard and recommended way to install the OneGuard CLI on macOS or Linux is via Homebrew. Since OneGuard uses a custom repository (Tap), you will need to trust it first before installing.

Step 1: Trust the OneGuard Repository Since this is a third-party tap, Homebrew requires you to explicitly trust it. Run this command once:

brew trust Onegurad/oneguard

Step 2: Install the CLI After trusting the repository, you can install the CLI directly:

brew install Onegurad/oneguard/oneguard

Updating the CLI Whenever a new version of OneGuard is released, you can easily update your local installation by running:

brew update
brew upgrade oneguard

Windows (via Chocolatey)

(Coming soon) Support for Chocolatey is currently in development. You will soon be able to install the CLI on Windows using:

choco install oneguard

Authentication

To get started, you must generate an API Key from the OneGuard Dashboard (Web/Mobile) and log in:

oneguard auth login <API_KEY>

Your key is securely stored in ~/.oneguard/credentials.json.