CLI

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:

If the openregister command is not found after installation, add the Go bin directory to your PATH:

export PATH="$PATH:$(go env GOPATH)/bin"

export PATH="$PATH:$(go env GOPATH)/bin"

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

Variable	Description	Required
`OPENREGISTER_API_KEY`	Your API key, sent as a Bearer token in the `Authorization` header	Yes

Flag	Description
`--api-key`	API key (can also be set with `OPENREGISTER_API_KEY`)
`--help`	Show command line usage
`--debug`	Enable debug logging, including HTTP request/response details
`--version`, `-v`	Show the CLI version
`--base-url`	Use a custom API backend URL
`--format`	Output format: `auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`
`--format-error`	Output format for errors: `auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`
`--transform`	Transform output using GJSON syntax
`--transform-error`	Transform error output using GJSON syntax