CLI Commands
insider 2026-10-14 JSON ↗Global Options
The following flags can be passed to any command:
| Flag | Short | Type | Description |
|---|---|---|---|
--config | -c | string | Path to configuration file |
--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 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).
nik cloudnik cloud auth
Authenticate with the Niksphere Cloud (login, logout, and status).
nik cloud authnik cloud auth login
Authenticates with the Niksphere Cloud.
- Default (without
--no-browser): initiates an interactive PKCE Authorization Code flow on127.0.0.1and 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. - Headless (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.
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.
nik cloud auth logoutnik cloud auth status
Displays whether you are currently logged in to the Niksphere Cloud, against which backend, and as which user.
nik cloud auth statusnik cloud env
Create, list, edit, and delete Niksphere Cloud Environments.
nik cloud envnik cloud env create
Create a new Niksphere Cloud Environment
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
nik cloud env delete <id>Arguments:
| Argument | Required | Description |
|---|---|---|
id | yes | <id> |
nik cloud env edit
Edit an existing Niksphere Cloud Environment
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
nik cloud env listnik cloud region
List available regions in the Niksphere Cloud.
nik cloud regionnik cloud region list
List all available Niksphere Cloud Regions
nik cloud region listnik cloud tenant
Create, list, edit, and delete tenants in the Niksphere Cloud.
nik cloud tenantnik cloud tenant create
Create a new Niksphere Cloud Tenant
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
nik cloud tenant delete <id>Arguments:
| Argument | Required | Description |
|---|---|---|
id | yes | <id> |
nik cloud tenant edit
Edit an existing Niksphere Cloud Tenant
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
nik cloud tenant listnik dev
Building, compiling, and testing Niksphere apps during development.
For more information, see the online documentation.
nik devnik dev compile
Compile and package a Niksphere App Project
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.
nik dev convertnik dev convert bc
Parses Business Central AL table and enum definitions from <input-dir> and generates standalone Niksphere Pascal (.pas) entities and enums in <output-dir>.
Automatically generates Niksphere UIDs and maps AL data types to Niksphere data types.
nik dev convert bc <input-dir> <output-dir> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
input-dir | yes | <input-dir> |
output-dir | yes | <output-dir> |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--define | -D | (None) | Preprocessor symbols to define (e.g. -D CLEAN28,CLEANSCHEMA27) |
nik dev dap
Starts the Niksphere Debug Adapter, communicating over stdio using the Debug Adapter Protocol.
This command is not intended to be run manually. It is started as a subprocess by a DAP-compatible editor or IDE (such as VS Code) to attach to a running Niksphere Engine and debug the next Client Runtime session it creates (e.g. from an API call).
nik dev dapnik dev generate-uid
Generate one or multiple random, cryptographically secure 10-character alphanumeric UIDs
nik dev generate-uid [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--count | (None) | 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.
nik dev initnik dev lsp
Starts the Niksphere Language Server, communicating over stdio using the Language Server Protocol.
This command is not intended to be run manually. It is started as a subprocess by an LSP-compatible editor or IDE (such as VS Code) to provide diagnostics, completions, and navigation for Niksphere files.
nik dev lspnik dev mcp
Registers or removes the Niksphere MCP server (nik mcp) in AI agent configuration files (.mcp.json, .cursor/mcp.json, .agents/mcp_config.json, .vscode/mcp.json) for the Niksphere App Project in the current directory.
nik dev mcpnik dev mcp disable
Removes the Niksphere entry from the AI agent configuration files of the Niksphere App Project in the current directory (or the given path).
Other MCP server entries in these files are left untouched; configuration files that become empty are deleted.
nik dev mcp disable [path] [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
path | no | [path] |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--client | (None) | (None) | Limit to specific clients (claude-code, cursor, antigravity, vscode). Default: all. |
nik dev mcp enable
Adds the Niksphere MCP server (nik mcp) to the AI agent configuration files of the Niksphere App Project in the current directory (or the given path), so tools like Claude Code, Cursor, Antigravity, or VS Code Copilot automatically get Niksphere-specific tools and guidance.
Writes to all supported clients unless --client narrows the selection. Existing entries for other MCP servers in these files are preserved; running it again is a no-op if nothing changed.
nik dev mcp enable [path] [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
path | no | [path] |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--client | (None) | (None) | Limit to specific clients (claude-code, cursor, antigravity, vscode). Default: all. |
nik dev mcp show
Prints a ready-to-paste JSON configuration snippet for each supported AI client that registers the Niksphere MCP server (nik mcp), or just the clients selected via --client.
Use --json to get a machine-readable list of the supported clients (id, label, config path) instead of the snippets - this is how other tools (e.g. the VS Code Extension) discover which clients are available, rather than hardcoding the list.
nik dev mcp show [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--client | (None) | (None) | Limit to specific clients (claude-code, cursor, antigravity, vscode). Default: all. |
nik dev publish
Compile and publish a Niksphere App Project to active environment in a single step
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
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.
nik env [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--server-url | -s | (None) | URL of the target Niksphere Engine server |
nik env actor
Create, update, and remove actors, and manage their sign-in identities (password, personal access tokens, external SSO).
nik env actornik env actor add
Create a new Actor in a Niksphere Environment
nik env actor add [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--name | -n | (None) | Actor name (required) |
--type | -t | USER | Actor type: USER or SERVICE |
nik env actor delete
Delete an Actor from a Niksphere Environment
nik env actor delete <actor-id>Arguments:
| Argument | Required | Description |
|---|---|---|
actor-id | yes | <actor-id> |
nik env actor edit
Edit an Actor in a Niksphere Environment
nik env actor edit <actor-id> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
actor-id | yes | <actor-id> |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--name | -n | (None) | New actor name |
--status | (None) | (None) | New status: ACTIVE or SUSPENDED |
nik env actor identity
Manage identities (Password, Personal Access Tokens, External SSO) for an Actor
nik env actor identitynik env actor identity external
Manage external SSO identities linked to an Actor
nik env actor identity externalnik env actor identity external delete
Delete an external SSO identity link for an Actor
nik env actor identity external delete <actor-id> <external-identity-id>Arguments:
| Argument | Required | Description |
|---|---|---|
actor-id | yes | <actor-id> |
external-identity-id | yes | <external-identity-id> |
nik env actor identity list
List all identities (Password, PATs, External SSO) for an Actor
nik env actor identity list <actor-id>Arguments:
| Argument | Required | Description |
|---|---|---|
actor-id | yes | <actor-id> |
nik env actor identity password
Manage embedded username/password identity for an Actor
nik env actor identity passwordnik env actor identity password set
Set or update the password identity for an Actor
nik env actor identity password set <actor-id> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
actor-id | yes | <actor-id> |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--password | -p | (None) | Password (required) |
--username | -u | (None) | Username (required) |
nik env actor identity pat
Manage Personal Access Tokens for an Actor
nik env actor identity patnik env actor identity pat create
Create a new Personal Access Token for an Actor
nik env actor identity pat create <actor-id> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
actor-id | yes | <actor-id> |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--expiry-days | (None) | 30 | Token validity in days (0 for no expiration) |
--name | -n | (None) | Token name / description (required) |
--scopes | (None) | (None) | Allowed scopes (e.g. 'data:read,apps:publish') |
nik env actor identity pat delete
Delete a Personal Access Token for an Actor
nik env actor identity pat delete <actor-id> <pat-id>Arguments:
| Argument | Required | Description |
|---|---|---|
actor-id | yes | <actor-id> |
pat-id | yes | <pat-id> |
nik env actor identity pat list
List all Personal Access Tokens for an Actor
nik env actor identity pat list <actor-id>Arguments:
| Argument | Required | Description |
|---|---|---|
actor-id | yes | <actor-id> |
nik env actor list
List all Actors in a Niksphere Environment
nik env actor listnik env app
Upload, list, install, uninstall and delete apps deployed to a Niksphere Environment.
nik env appnik env app delete
Delete a Niksphere App from the active Niksphere Environment
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
nik env app download <app-id> <version> [output-dir]Arguments:
| Argument | Required | Description |
|---|---|---|
app-id | yes | <app-id> |
version | yes | <version> |
output-dir | no | [output-dir] |
nik env app drop-data
Drop all data for an uninstalled Niksphere App
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
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 the active Niksphere Environment
nik env app listnik env app uninstall
Uninstall a Niksphere App from the active Niksphere Environment
nik env app uninstall <id>Arguments:
| Argument | Required | Description |
|---|---|---|
id | yes | <id> |
nik env app upload
Upload a Niksphere App Package to the active Niksphere Environment
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 a Niksphere Environment (login, logout, and status).
nik env authnik env auth login
Authenticates with a specified Niksphere Environment.
- Default (without
--no-browser): initiates an interactive PKCE Authorization Code flow on127.0.0.1and 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. - Headless (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.
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.
nik env auth logoutnik env auth status
Displays whether you are currently logged in, against which engine, and as which user.
nik env auth statusnik env client
Register, update, activate or deactivate, and remove OAuth clients.
nik env clientnik env client add
Register a new OAuth Client in a Niksphere Environment
nik env client add [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--actor-id | (None) | (None) | Linked Service Actor ID (for S2S client credentials) |
--client-id | -i | (None) | Unique client identifier (required) |
--client-name | -n | (None) | Display name of the client (required) |
--grants | (None) | (None) | Allowed grant types |
--redirect-uris | (None) | (None) | Allowed redirect URIs |
--secret | (None) | (None) | Client secret (required for CONFIDENTIAL clients) |
--type | -t | PUBLIC | Client profile: PUBLIC or CONFIDENTIAL |
nik env client delete
Delete an OAuth Client from a Niksphere Environment
nik env client delete <id>Arguments:
| Argument | Required | Description |
|---|---|---|
id | yes | <id> |
nik env client disable
Disable an OAuth Client in a Niksphere Environment
nik env client disable <id>Arguments:
| Argument | Required | Description |
|---|---|---|
id | yes | <id> |
nik env client edit
Edit an OAuth Client in a Niksphere Environment
nik env client edit <id> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
id | yes | <id> |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--grants | (None) | (None) | New allowed grants |
--name | -n | (None) | New display name |
--redirect-uris | (None) | (None) | New allowed redirect URIs |
nik env client enable
Enable an OAuth Client in a Niksphere Environment
nik env client enable <id>Arguments:
| Argument | Required | Description |
|---|---|---|
id | yes | <id> |
nik env client list
List all OAuth Clients in a Niksphere Environment
nik env client listnik env idp
Subcommands for managing external identity providers.
nik env idpnik env idp external
Manage External Identity Providers
nik env idp externalnik env idp external add
Add a new Niksphere External Identity Provider
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
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
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 | -n | (None) | New name for the IdP |
--scopes | (None) | (None) | New OIDC Scopes |
nik env idp external list
List all Niksphere External Identity Providers
nik env idp external listnik env inspect
Subcommands for inspecting the active Niksphere Environment, monitoring health, and exploring data.
nik env inspectnik 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.
nik env inspect datanik env inspect monitor
Connects to the active Niksphere Environment via WebSockets to stream live logs, database status, and memory metrics directly into your terminal.
nik env inspect monitor [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--stream | (None) | (None) | Output log events directly as a continuous stream of text |
nik env session
List and terminate active Client Runtime Sessions.
nik env sessionnik env session list
List active Client Runtime Sessions on a Niksphere Environment
nik env session listnik env session terminate
Terminate an active Client Runtime Session on a Niksphere Environment
nik env session terminate <id>Arguments:
| Argument | Required | Description |
|---|---|---|
id | yes | <id> |
nik env task
Inspect, follow live streams, and manage background tasks executing on a Niksphere Environment.
nik env tasknik env task cancel
Cancels a task if it is still in the queued state. Running tasks cannot be cancelled to preserve data integrity.
nik env task cancel <task-id>Arguments:
| Argument | Required | Description |
|---|---|---|
task-id | yes | <task-id> |
nik env task follow
Connects to the streaming endpoint of a running or queued background task and renders real-time progress.
nik env task follow <task-id>Arguments:
| Argument | Required | Description |
|---|---|---|
task-id | yes | <task-id> |
Aliases: stream, attach
nik env task list
List all background tasks in the active Niksphere Environment
nik env task listAliases: ls
nik env task show
Show details and current status of a background task
nik env task show <task-id>Arguments:
| Argument | Required | Description |
|---|---|---|
task-id | yes | <task-id> |
nik mcp
Starts the Niksphere MCP server, communicating over stdio using the Model Context Protocol, and exposes the Niksphere CLI's commands as tools plus Niksphere-specific architectural guidance.
This command is not intended to be run manually. It is started as a subprocess by an MCP-compatible AI client (such as Claude Code, Cursor, or Antigravity) once registered via nik dev mcp enable.
nik mcpnik self
Manage components, check for updates, and print info about the Niksphere CLI itself.
nik selfnik self about
Print information about Niksphere CLI
nik self aboutnik self completion
Generate the autocompletion script for nik for the specified shell. See each sub-command's help for details on how to use the generated script.
nik self completion [bash|zsh|fish|powershell]Arguments:
| Argument | Required | Description |
|---|---|---|
| `bash | zsh | fish |
nik self completion bash
Generate the autocompletion script for the bash shell.
This script depends on the bash-completion package. If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
source <(nik self completion bash)To load completions for every new session, execute once:
Linux:
nik self completion bash > /etc/bash_completion.d/nikmacOS:
nik self completion bash > $(brew --prefix)/etc/bash_completion.d/nikYou will need to start a new shell for this setup to take effect.
nik self completion bash [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--no-descriptions | (None) | (None) | disable completion descriptions |
nik self completion fish
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
nik self completion fish | sourceTo load completions for every new session, execute once:
nik self completion fish > ~/.config/fish/completions/nik.fishYou will need to start a new shell for this setup to take effect.
nik self completion fish [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--no-descriptions | (None) | (None) | disable completion descriptions |
nik self completion powershell
Generate the autocompletion script for powershell.
To load completions in your current shell session:
nik self completion powershell | Out-String | Invoke-ExpressionTo load completions for every new session, add the output of the above command to your PowerShell profile ($PROFILE).
nik self completion powershell [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--no-descriptions | (None) | (None) | disable completion descriptions |
nik self completion zsh
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrcTo load completions in your current shell session:
source <(nik self completion zsh)To load completions for every new session, execute once:
Linux:
nik self completion zsh > "${fpath[1]}/_nik"macOS:
nik self completion zsh > $(brew --prefix)/share/zsh/site-functions/_nikYou will need to start a new shell for this setup to take effect.
nik self completion zsh [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--no-descriptions | (None) | (None) | disable completion descriptions |
nik self release-notes
Show release notes for the currently installed version
nik self release-notesnik self uninstall
Uninstall Niksphere CLI and remove system integrations
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
nik self update [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--channel | (None) | 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 update release-notes
Show release notes for the versions an update would install
nik self update release-notes