{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Hyperproof CLI","description":"Hyperproof developer resources for custom integrations.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"hyperproof-cli","__idx":0},"children":["Hyperproof CLI"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Hyperproof command-line interface (Hyperproof CLI) provides a set of commands used to create, read, update and delete data that is stored in a Hyperproof organization."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"installation","__idx":2},"children":["Installation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Hyperproof CLI is a cross-platform command line tool that can be installed the following platforms:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#install-on-linux"},"children":["Linux (Ubuntu)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#install-on-windows"},"children":["Windows 10 and 11"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Hyperproof CLI has a dependency on the .Net Runtime 8.0. Before installing the Hyperproof CLI, please install the .Net Runtime 8.0 using the link below."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dotnet.microsoft.com/en-us/download/dotnet/8.0"},"children":["Download .Net 8.0"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"install-on-linux","__idx":3},"children":["Install on Linux"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Hyperproof CLI has been tested on the following Linux distributions."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Distribution"},"children":["Distribution"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Version"},"children":["Version"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ubuntu"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["18.04 LTS (Bionic Beaver), 20.04 LTS (Focal Fossa), 22.04 (Jammy Jellyfish)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It may also be installed on other Debian distributions but the Hyperproof CLI has not been tested on these platforms."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have installed the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dotnet.microsoft.com/en-us/download/dotnet/8.0"},"children":[".Net Runtime 8.0"]},", the CLI can be installed by downloading a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".deb"]}," package from the Hyperproof web site. Click the link below to download the latest version of the Hyperproof CLI."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://downloads.hyperproof.app/hpcli/hpcli_1.2.6-1_amd64.deb"},"children":["Download HP CLI ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".deb"]}," for Debian Linux Distributions"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".deb"]}," package installs the HP CLI under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/usr/bin"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"install-on-windows","__idx":4},"children":["Install on Windows"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For Windows, the Hyperproof CLI is installed using an installation executable that can be downloaded from the Hyperproof web site."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Hyperproof CLI has been tested on the following Windows versions."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Version"},"children":["Version"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Windows 10"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Windows 11"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have installed the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dotnet.microsoft.com/en-us/download/dotnet/8.0"},"children":[".Net Runtime 8.0"]},", click the link below to download and run the HP CLI Windows installer."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://downloads.hyperproof.app/hpcli/hpcli-1.2.6.exe"},"children":["Download HP CLI Windows Installer"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Hyperproof CLI will be installed under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["C:\\Program Files\\Hyperproof CLI"]}," unless you choose a different installation location. The installation directory should be added to your path."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"install-on-mac","__idx":5},"children":["Install on Mac"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Hyperproof CLI for Mac depends on the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dotnet.microsoft.com/en-us/download/dotnet/8.0"},"children":[".Net Runtime 8.0"]},". Use the links on that page to install the appropriate .Net 8.0 Runtime for your system."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have installed the .Net Runtime, you can use Homebrew to install, update and uninstall the Hyperproof CLI. If you don't have Homebrew available on your system, install ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.brew.sh/Installation.html"},"children":["Homebrew"]}," before continuing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can install the Hyperproof CLI on macOS by adding the Hyperproof tap, and then running the install command:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"brew tap Hyperproof/hyperproof\nbrew install hyperproof-cli\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have already installed an earlier version of the Hyperproof CLI, you can upgrade to the latest version with this command:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"brew upgrade hyperproof-cli\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"installation-verification","__idx":6},"children":["Installation Verification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the installation is complete, confirm the installation by running the following command:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"hp --version\n"},"children":[]}]},"headings":[{"value":"Hyperproof CLI","id":"hyperproof-cli","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Installation","id":"installation","depth":2},{"value":"Install on Linux","id":"install-on-linux","depth":3},{"value":"Install on Windows","id":"install-on-windows","depth":3},{"value":"Install on Mac","id":"install-on-mac","depth":3},{"value":"Installation Verification","id":"installation-verification","depth":3}],"frontmatter":{"seo":{"title":"Hyperproof CLI"}},"lastModified":"2026-04-28T16:53:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/hypersync-sdk/doc/hyperproof-cli","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}