CLI — `entihub`

The entihub command-line tool maps one invocation to one API operation. It is designed for CI/CD, DevOps automation, and AI agents that need stable, scriptable access with machine-readable output.

Overview

One command equals one API operation.
Ideal for scripting and orchestration.
Supports machine-readable JSON output via --json.

Installation

Ships with the product container.
Standalone binaries are available for Windows and Linux.

Install from NuGet as a global .NET tool:

dotnet tool install -g EntiHub.Cli

Verify installation:

entihub --help

Update to the latest version:

dotnet tool update -g EntiHub.Cli

Install a specific version:

dotnet tool install -g EntiHub.Cli --version 1.0.0

Version compatibility

For compatibility, the CLI version and the EntiHub web application version should be the same.

Recommended: install the same CLI version as the web app version.
If versions differ, some commands may fail or return unexpected validation errors.

You can find the web app version in the UI:

Open the application.
In the top-right corner, open the Settings menu (gear icon).
The version is shown under the Tier value.

Install a matching CLI version:

dotnet tool install -g EntiHub.Cli --version <web-app-version>

Configuration

Store default connection settings in the user profile:

entihub config set \
  --base-url https://entihub.contoso.com \
  --tenant-id <your-tenant-id> \
  --client-id <app-client-id>
entihub config show
entihub config path

Configuration is stored in ~/.entihub/config.json.

Authentication

Modes:

ENTIHUB_TENANT_ID=<tenant-id>
ENTIHUB_CLIENT_ID=<client-id>
ENTIHUB_CLIENT_SECRET=<client-secret>
ENTIHUB_API_KEY=<optional-api-key>

Interactive login: entihub login
Service principal: use the environment variables above.
API key: set ENTIHUB_API_KEY or pass --api-key.

Verify the current identity with:

entihub whoami --json

Entity definition commands

entihub entities list
entihub entities summary
entihub entities get <name>
entihub entities yaml <name>
entihub entities parse-yaml --file <file>
entihub entities validate --file <file>
entihub entities create --file <file>
entihub entities save <name> --file <file>
entihub entities update <name> --file <file>
entihub entities delete <name>

Deploy commands

entihub entities deploy <name>
entihub entities deploy-preview <name>
entihub entities redeploy <name>
entihub entities deploy-remove <name>
entihub entities deploy-drop-archive <name>
entihub entities deploy-history <name>

Data commands

entihub entities data list <name> [--skip N] [--take N] [--sort col] [--filter expr] [--deleted]
entihub entities data get <name> <id> [--approved-snapshot]
entihub entities data create <name> --file <json>
entihub entities data update <name> <id> --file <json>
entihub entities data delete <name> <id> [--soft]
entihub entities data restore <name> <id>
entihub entities data export <name> [--format csv|json]
entihub entities data bulk <name> --file <json>
entihub entities data bulk-csv <name> --file <csv>
entihub entities data similar <name> --file <json>
entihub entities data ref-options <name>
entihub entities data column-suggestions <name> <column>

Aliases & views

entihub entities aliases list <name>
entihub entities aliases get <name> <id>
entihub entities aliases create <name> --file <json>
entihub entities aliases delete <name> <id>
entihub entities view <name> <apiName> [--skip N] [--take N] [--format csv|json]

Approval commands

entihub approval pending <name>
entihub approval batches <name>
entihub approval approve <name> <id>
entihub approval approve-batch <name> --file <json>
entihub approval reject <name> <id>
entihub approval reject-batch <name> --file <json>
entihub approval versions <name> <id>

Admin commands

entihub permissions list [--entity name] [--domain name]
entihub permissions set --file <json>
entihub permissions yaml-export
entihub permissions yaml-import --file <yaml>
entihub webhooks list
entihub webhooks create --file <json>
entihub webhooks yaml-export
entihub webhooks yaml-import --file <yaml>
entihub audit [--entity name] [--user email] [--action type]
entihub changes [--entity name] [--after-id N]
entihub search entities --q text
entihub search data --q text [--entity name]

Package commands

entihub packages export [--file <options-json>]
entihub packages deploy --file <package.zip> [--overwrite-existing] [--import-permissions] [--import-webhooks] [--import-seed]

Global flags

--json — JSON output.
--base-url <url> — override configured base URL.
--api-key <secret> — authenticate using X-API-Key.
--help — per-command help.

Raw API mode

For HTTP operations not covered by a named command:

entihub api <METHOD> <path> [--query <raw>] [--file <path-or->] [--content-type <type>] [--no-auth]

Health & identity

entihub health
entihub ready
entihub whoami
entihub me

CLI — entihub