Skip to main content
The OpenRegister CLI is the official command-line interface for the OpenRegister REST API.

​
Installation

Requires Go 1.22 or later. 
go install 'github.com/oregister/openregister-cli/cmd/openregister@latest'
The binary is placed in your Go bin directory after installation:
  • Default location: $HOME/go/bin (or $GOPATH/bin if GOPATH is set)
  • Check your path: Run go env GOPATH to see the base directory
If the openregister command is not found after installation, add the Go bin directory to your PATH: 
export PATH="$PATH:$(go env GOPATH)/bin"

​
Usage

The CLI follows a resource-based command structure: 
openregister [resource] <command> [flags...]
Example — fetch company details: 
openregister company get-details-v1 \
  --api-key 'My API Key' \
  --company-id DE-HRB-F1103-267645
For details about any command, use the --help flag: 
openregister --help
openregister company --help

​
Environment Variables

VariableDescriptionRequired
OPENREGISTER_API_KEYYour API key, sent as a Bearer token in the Authorization headerYes

​
Global Flags

FlagDescription
--api-keyAPI key (can also be set with OPENREGISTER_API_KEY)
--helpShow command line usage
--debugEnable debug logging, including HTTP request/response details
--version, -vShow the CLI version
--base-urlUse a custom API backend URL
--formatOutput format: auto, explore, json, jsonl, pretty, raw, yaml
--format-errorOutput format for errors: auto, explore, json, jsonl, pretty, raw, yaml
--transformTransform output using GJSON syntax
--transform-errorTransform error output using GJSON syntax