# Hyperproof CLI

## Overview

The Hyperproof command-line interface (Hyperproof CLI) provides a set of commands used to create, read, update, and delete data that's stored in a Hyperproof organization.

## Installation

The Hyperproof CLI is a cross-platform command line tool that can be installed the following platforms:

- Linux (Ubuntu)
- Windows 10 and 11
- macOS


### Prerequisites

- [.Net Runtime 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)


The Hyperproof CLI has a dependency on .Net Runtime 8.0. Before installing the Hyperproof CLI, install .Net Runtime 8.0.

### Installing on Linux

The Hyperproof CLI has been tested on the following Linux distributions:

- Ubuntu 8.04 LTS (Bionic Beaver)
- Ubuntu 20.04 LTS (Focal Fossa)
- Ubuntu 22.04 (Jammy Jellyfish)


> **Note**: You can install the Hyperproof CLI on other Debian distributions. However, it has only been tested on the versions listed above.


After you install .Net Runtime 8.0, the CLI can be installed by downloading a `.deb` package from the [Hyperproof website](https://downloads.hyperproof.app/hpcli/hpcli_1.2.4-1_amd64.deb).

> **Note**: The `.deb` package installs the Hyperproof CLI under `/usr/bin`.


### Installing on Windows

For Windows, the Hyperproof CLI is intalled using an installation executable.

The Hyperproof CLI has been tested on the following Windows versions:

- Windows 10
- Windows 11


After you install .Net Runtime 8.0, the CLI can be installed from the [Hyperproof website](https://downloads.hyperproof.app/hpcli/hpcli-1.2.4.exe).

The Hyperproof CLI is installed under `C:\Program Files\Hyperproof CLI`, unless you choose a different installation location. The installation directory should be added to your path.

### Installing on macOS

After you install .Net Runtime 8.0, you can use [Homebrew](https://docs.brew.sh/Installation.html) to install, update, and uninstall the Hyperproof CLI.

To install the Hyperproof CLI on macOS, add Hyperproof tap, then run the following command:


```
brew tap Hyperproof/hyperproof
brew install hyperproof-cli
```

To upgrade your version of the Hyperproof CLI, run the following command:


```
brew upgrade hyperproof-cli
```

### Installation verification

To confirm the installation, run the following command:


```
hp --version
```