CLI Commands

insider 2026-08-18 JSON ↗

Global Options

The following flags can be passed to any command:

Flag	Short	Type	Description
`--json`	`-j`	`boolean`	Output results in JSON format

Commands Overview

Command	Description
`nik cloud`	Commands for interacting with the Niksphere Cloud (https://my.niksphere.de)
`nik dev`	Commands for development tools for Niksphere Apps
`nik env`	Commands for interacting with Niksphere Environments
`nik help`	Help about any command
`nik mcp`	Starts the Model Context Protocol (MCP) server via Stdio
`nik self`	Manage the Niksphere CLI itself

`nik cloud`

Commands for administration and authentication against the Niksphere Cloud (https://my.niksphere.de).

bash

nik cloud

`nik cloud auth`

Authenticate with the Niksphere Cloud (login, logout, and status).

bash

nik cloud auth

`nik cloud auth login`

Authenticates with the Niksphere Cloud.

Authentication Behaviors:

Default (without --no-browser): Initiates an interactive PKCE Authorization Code flow on 127.0.0.1 and opens your default browser. If the local loopback server is unavailable or blocked by network policies, it automatically falls back to OAuth 2.0 Device Code authentication.
With --no-browser: Suppresses automatic local browser launch for remote, SSH, or headless terminal sessions. Displays an 8-character verification code, authorization URL, and ASCII QR code directly in the terminal.

bash

nik cloud auth login [server-url] [flags]

Arguments:

Argument	Required	Description
`server-url`	`no`	[server-url]

Flags:

Flag	Short	Default	Description
`--no-browser`	(None)	(None)	Do not launch a browser; display verification code and QR code for remote/SSH sessions

`nik cloud auth logout`

Logs out by securely removing your local Cloud authentication token.

bash

nik cloud auth logout

`nik cloud auth status`

Displays whether you are currently logged in to the Niksphere Cloud, against which backend, and as which user.

bash

nik cloud auth status

`nik cloud env`

Create, list, edit, and delete Niksphere Cloud Environments.

bash

nik cloud env

`nik cloud env create`

Create a new Niksphere Cloud Environment

bash

nik cloud env create <name> <slug> <region>

Arguments:

Argument	Required	Description
`name`	`yes`	<name>
`slug`	`yes`	<slug>
`region`	`yes`	<region>

`nik cloud env delete`

Delete a Niksphere Cloud Environment

bash

nik cloud env delete <id>

Arguments:

Argument	Required	Description
`id`	`yes`	<id>

`nik cloud env edit`

Edit an existing Niksphere Cloud Environment

bash

nik cloud env edit <id> [flags]

Arguments:

Argument	Required	Description
`id`	`yes`	<id>

Flags:

Flag	Short	Default	Description
`--name`	(None)	(None)	New name for the environment
`--slug`	(None)	(None)	New slug for the environment

`nik cloud env list`

List all Niksphere Cloud Environments

bash

nik cloud env list

`nik cloud region`

List available regions in the Niksphere Cloud.

bash

nik cloud region

`nik cloud region list`

List all available Niksphere Cloud Regions

bash

nik cloud region list

`nik cloud tenant`

Create, list, edit, and delete tenants in the Niksphere Cloud.

bash

nik cloud tenant

`nik cloud tenant create`

Create a new Niksphere Cloud Tenant

bash

nik cloud tenant create <name> <slug>

Arguments:

Argument	Required	Description
`name`	`yes`	<name>
`slug`	`yes`	<slug>

`nik cloud tenant delete`

Delete a Niksphere Cloud Tenant

bash

nik cloud tenant delete <id>

Arguments:

Argument	Required	Description
`id`	`yes`	<id>

`nik cloud tenant edit`

Edit an existing Niksphere Cloud Tenant

bash

nik cloud tenant edit <id> [flags]

Arguments:

Argument	Required	Description
`id`	`yes`	<id>

Flags:

Flag	Short	Default	Description
`--name`	(None)	(None)	New name for the tenant
`--slug`	(None)	(None)	New slug for the tenant

`nik cloud tenant list`

List all Niksphere Cloud Tenants

bash

nik cloud tenant list

`nik dev`

Building, compiling, and testing Niksphere apps during development.

bash

nik dev

`nik dev compile`

Compile and package a Niksphere App Project

bash

nik dev compile [path] [flags]

Arguments:

Argument	Required	Description
`path`	`no`	[path]

Flags:

Flag	Short	Default	Description
`--ignore-phase-errors`	`-i`	(None)	Run all compilation phases even if earlier phases contain errors

`nik dev convert`

Subcommands for converting external source code or structures into Niksphere formats.

bash

nik dev convert

`nik dev convert bc`

Parses Business Central AL table and enum definitions from the <input-dir> and generates standalone Niksphere Pascal (.pas) entities and enums in the <output-dir>. Automatically generates Niksphere UIDs and maps AL data types to Niksphere data types.

bash

nik dev convert bc <input-dir> <output-dir>

Arguments:

Argument	Required	Description
`input-dir`	`yes`	<input-dir>
`output-dir`	`yes`	<output-dir>

`nik dev generate-uid`

Generate one or multiple random, cryptographically secure 10-character alphanumeric UIDs

bash

nik dev generate-uid [flags]

Flags:

Flag	Short	Default	Description
`--count`	`-c`	`1`	Number of UIDs to generate (1-50)

`nik dev init`

Creates a basic Niksphere App Project structure in the current directory. Aborts if nikapp.yaml already exists.

bash

nik dev init

`nik dev integrate`

Subcommands for integrating Niksphere with external tools like VS Code or AI Assistants.

bash

nik dev integrate

`nik dev integrate lsp`

Starts the Language Server Protocol (LSP) via Stdio

bash

nik dev integrate lsp

`nik dev publish`

Compile and publish a Niksphere App Project to active environment in a single step

bash

nik dev publish [path] [flags]

Arguments:

Argument	Required	Description
`path`	`no`	[path]

Flags:

Flag	Short	Default	Description
`--allow-drops`	`-d`	(None)	Allow destructive database changes (drop columns/tables)
`--ignore-phase-errors`	`-i`	(None)	Run all compilation phases even if earlier phases contain errors
`--server`	(None)	(None)	Alias for --server-url
`--server-url`	`-s`	(None)	URL of target Niksphere Engine server

`nik dev validate`

Validate a Niksphere App Project at the specified path without compiling it to a package file

bash

nik dev validate [path] [flags]

Arguments:

Argument	Required	Description
`path`	`no`	[path]

Flags:

Flag	Short	Default	Description
`--ignore-phase-errors`	`-i`	(None)	Run all compilation phases even if earlier phases contain errors

`nik env`

Commands for administration and authentication against a Niksphere Environment.

bash

nik env [flags]

Flags:

Flag	Short	Default	Description
`--server-url`	`-s`	(None)	URL of the target Niksphere Engine server

`nik env app`

Upload, list, install, uninstall and delete apps deployed to a Niksphere instance.

bash

nik env app

`nik env app delete`

Delete a Niksphere App from active Niksphere Environment

bash

nik env app delete <id> <version>

Arguments:

Argument	Required	Description
`id`	`yes`	<id>
`version`	`yes`	<version>

`nik env app download`

Download an installed Niksphere App Package

bash

nik env app download <app-id> <version> [output-dir] [flags]

Arguments:

Argument	Required	Description
`app-id`	`yes`	<app-id>
`version`	`yes`	<version>
`output-dir`	`no`	[output-dir]

Flags:

Flag	Short	Default	Description
`--sym`	(None)	(None)	Download the compiled Symbol file (.niksym) instead of the app file (.nikapp)

`nik env app drop-data`

Drop all data for an uninstalled Niksphere App

bash

nik env app drop-data <id> [flags]

Arguments:

Argument	Required	Description
`id`	`yes`	<id>

Flags:

Flag	Short	Default	Description
`--yes`	`-y`	(None)	Confirm and skip interactive prompt

`nik env app install`

Install a Niksphere App Package

bash

nik env app install <id> <version> [flags]

Arguments:

Argument	Required	Description
`id`	`yes`	<id>
`version`	`yes`	<version>

Flags:

Flag	Short	Default	Description
`--allow-drops`	`-d`	(None)	Allow destructive database changes (drop columns/tables)

`nik env app list`

List all installed Niksphere Apps in active Niksphere Environment

bash

nik env app list

`nik env app uninstall`

Uninstall a Niksphere App from active Niksphere Environment

bash

nik env app uninstall <id>

Arguments:

Argument	Required	Description
`id`	`yes`	<id>

`nik env app upload`

Upload a Niksphere App Package to active Niksphere Environment

bash

nik env app upload <path-to-.nikapp-file>

Arguments:

Argument	Required	Description
`path-to-.nikapp-file`	`yes`	<path-to-.nikapp-file>

`nik env auth`

Authenticate with the Niksphere engine (login, logout, and status).

bash

nik env auth

`nik env auth login`

Authenticates with a specified Niksphere Environment.

Authentication Behaviors:

Default (without --no-browser): Initiates an interactive PKCE Authorization Code flow on 127.0.0.1 and opens your default browser. If the local loopback server is unavailable or blocked by network policies, it automatically falls back to OAuth 2.0 Device Code authentication.
With --no-browser: Suppresses automatic local browser launch for remote, SSH, or headless terminal sessions. Displays an 8-character verification code, authorization URL, and ASCII QR code directly in the terminal.

bash

nik env auth login <engine-url> [flags]

Arguments:

Argument	Required	Description
`engine-url`	`yes`	<engine-url>

Flags:

Flag	Short	Default	Description
`--no-browser`	(None)	(None)	Do not launch a browser; display verification code and QR code for remote/SSH sessions

`nik env auth logout`

Logs out by securely removing your local authentication token.

bash

nik env auth logout

`nik env auth status`

Displays whether you are currently logged in, against which engine, and as which user.

bash

nik env auth status

`nik env identity`

Manage Niksphere Environment Identities

bash

nik env identity

`nik env identity add`

Add a new Niksphere Environment Identity to active Niksphere Environment

bash

nik env identity add <username> <password>

Arguments:

Argument	Required	Description
`username`	`yes`	<username>
`password`	`yes`	<password>

`nik env identity delete`

Delete a Niksphere Environment Identity from active Niksphere Environment

bash

nik env identity delete <username>

Arguments:

Argument	Required	Description
`username`	`yes`	<username>

`nik env identity edit`

Edit an existing Niksphere Environment Identity in active Niksphere Environment (e.g. change password)

bash

nik env identity edit <username> <new_password>

Arguments:

Argument	Required	Description
`username`	`yes`	<username>
`new_password`	`yes`	<new_password>

`nik env identity list`

List all Niksphere Environment Identities in active Niksphere Environment

bash

nik env identity list

`nik env idp`

Manage Niksphere Identity Providers

bash

nik env idp

`nik env idp external`

Manage External Identity Providers

bash

nik env idp external

`nik env idp external add`

Add a new Niksphere External Identity Provider

bash

nik env idp external add <name> [flags]

Arguments:

Argument	Required	Description
`name`	`yes`	<name>

Flags:

Flag	Short	Default	Description
`--active`	(None)	`true`	Is this IdP active?
`--auto-provision`	(None)	(None)	Auto-provision users from this IdP?
`--client-id`	(None)	(None)	OIDC Client ID (required)
`--client-secret`	(None)	(None)	OIDC Client Secret (required)
`--issuer-url`	(None)	(None)	OIDC Issuer URL (required)
`--scopes`	(None)	`openid profile email offline_access`	OIDC Scopes

`nik env idp external delete`

Delete a Niksphere External Identity Provider

bash

nik env idp external delete <id>

Arguments:

Argument	Required	Description
`id`	`yes`	<id>

`nik env idp external edit`

Edit an existing Niksphere External Identity Provider

bash

nik env idp external edit <id> [flags]

Arguments:

Argument	Required	Description
`id`	`yes`	<id>

Flags:

Flag	Short	Default	Description
`--active`	(None)	(None)	Set active status (true/false)
`--auto-provision`	(None)	(None)	Set auto-provision status (true/false)
`--client-id`	(None)	(None)	New OIDC Client ID
`--client-secret`	(None)	(None)	New OIDC Client Secret
`--issuer-url`	(None)	(None)	New OIDC Issuer URL
`--name`	(None)	(None)	New name for the IdP
`--scopes`	(None)	(None)	New OIDC Scopes

`nik env idp external list`

List all Niksphere External Identity Providers

bash

nik env idp external list

`nik env inspect`

Subcommands for inspecting the Niksphere instance, monitoring health, and exploring data.

bash

nik env inspect

`nik env inspect data`

Launch an interactive terminal UI to explore your installed applications, database tables, and real data mapped back to their logical, human-readable names.

bash

nik env inspect data

`nik env inspect monitor`

Connects to a running Niksphere engine instance via WebSockets to stream live logs, database status, and memory metrics directly into your terminal.

bash

nik env inspect monitor [flags]

Flags:

Flag	Short	Default	Description
`--stream`	(None)	(None)	Output log events directly as a continuous stream of text

`nik help`

Help provides help for any command in the application. Simply type nik help [path to command] for full details.

bash

nik help

`nik mcp`

Starts the Model Context Protocol (MCP) server via Stdio

bash

nik mcp

`nik self`

Manage components, check for updates, and print info about the Niksphere CLI itself.

bash

nik self

`nik self about`

Print information about Niksphere CLI

bash

nik self about

`nik self uninstall`

Uninstall Niksphere CLI and remove system integrations

bash

nik self uninstall [flags]

Flags:

Flag	Short	Default	Description
`--yes`	`-y`	(None)	Skip interactive confirmation prompt

`nik self update`

Update the Niksphere CLI to the latest version

bash

nik self update [flags]

Flags:

Flag	Short	Default	Description
`--channel`	`-c`	`stable`	Release channel to check (stable, insider)
`--check`	(None)	(None)	Only check for new versions without updating
`--force`	`-f`	(None)	Force update even if version is up-to-date
`--yes`	`-y`	(None)	Skip interactive confirmation prompt

`nik self usage`

Export the full Niksphere CLI command hierarchy, options, and flags as a standardized Usage JSON specification.

bash

nik self usage [flags]

Flags:

Flag	Short	Default	Description
`--format`	`-f`	`json`	Output format ('json' or 'kdl')
`--out`	`-o`	(None)	File path to save the generated usage specification

CLI Commands ​

Global Options ​

Commands Overview ​

nik cloud ​

nik cloud auth ​

nik cloud auth login ​

nik cloud auth logout ​

nik cloud auth status ​

nik cloud env ​

nik cloud env create ​

nik cloud env delete ​

nik cloud env edit ​

nik cloud env list ​

nik cloud region ​

nik cloud region list ​

nik cloud tenant ​

nik cloud tenant create ​

nik cloud tenant delete ​

nik cloud tenant edit ​

nik cloud tenant list ​

nik dev ​

nik dev compile ​

nik dev convert ​

nik dev convert bc ​

nik dev generate-uid ​

nik dev init ​

nik dev integrate ​

nik dev integrate lsp ​

nik dev publish ​

nik dev validate ​

nik env ​

nik env app ​

nik env app delete ​

nik env app download ​

nik env app drop-data ​

nik env app install ​

nik env app list ​

nik env app uninstall ​

nik env app upload ​

nik env auth ​

nik env auth login ​

nik env auth logout ​

nik env auth status ​

nik env identity ​

nik env identity add ​

nik env identity delete ​

nik env identity edit ​

nik env identity list ​

nik env idp ​

nik env idp external ​

nik env idp external add ​

nik env idp external delete ​

nik env idp external edit ​

nik env idp external list ​

nik env inspect ​

nik env inspect data ​

nik env inspect monitor ​

nik help ​

nik mcp ​

nik self ​

nik self about ​

nik self uninstall ​

nik self update ​

nik self usage ​

CLI Commands

Global Options

Commands Overview

`nik cloud`

`nik cloud auth`

`nik cloud auth login`

`nik cloud auth logout`

`nik cloud auth status`

`nik cloud env`

`nik cloud env create`

`nik cloud env delete`

`nik cloud env edit`

`nik cloud env list`

`nik cloud region`

`nik cloud region list`

`nik cloud tenant`

`nik cloud tenant create`

`nik cloud tenant delete`

`nik cloud tenant edit`

`nik cloud tenant list`

`nik dev`

`nik dev compile`

`nik dev convert`

`nik dev convert bc`

`nik dev generate-uid`

`nik dev init`

`nik dev integrate`

`nik dev integrate lsp`

`nik dev publish`

`nik dev validate`

`nik env`

`nik env app`

`nik env app delete`

`nik env app download`

`nik env app drop-data`

`nik env app install`

`nik env app list`

`nik env app uninstall`

`nik env app upload`

`nik env auth`

`nik env auth login`

`nik env auth logout`

`nik env auth status`

`nik env identity`

`nik env identity add`

`nik env identity delete`

`nik env identity edit`

`nik env identity list`

`nik env idp`

`nik env idp external`

`nik env idp external add`

`nik env idp external delete`

`nik env idp external edit`

`nik env idp external list`

`nik env inspect`

`nik env inspect data`

`nik env inspect monitor`

`nik help`

`nik mcp`

`nik self`

`nik self about`

`nik self uninstall`

`nik self update`

`nik self usage`