npl-cli

NPL CLI

You can find the full CLI documentation here: cli.md

Versioning

The NPL CLI uses a versioning scheme aligned with Noumena Platform releases.

Examples

• 2025.1.2 — Base release matching the Noumena Platform version.
• 2025.1.2-1 — First CLI-specific patch based on platform version 2025.1.2.

This helps ensure consistency between the platform and CLI tool while allowing independent CLI updates when needed.

Development

Prerequisites

You'll need Maven and Java 24 (graalvm if you want to build binaries) or later installed on your system.

Build Profiles

The project has three build profiles for different testing scenarios:

Default Profile

Regular testing that runs integration tests directly without using binary:

mvn clean test

Native Profile

Builds a native binary and runs integration tests against it:

mvn clean verify -Pnative

Config Generation Profile

Builds a fat JAR and instruments it with the native agent to generate GraalVM native image configuration:

mvn clean verify -Pconfig-gen

Automated checks and formatting

You can use pre-commit to run some automated checks as well as Kotlin (ktlint) and Markdown formatting whenever you
commit something.

brew install pre-commit
pre-commit install

The checks can be bypassed by running git commit -n or git commit --no-verify

detect-secrets

Enforces accidental secret commits with a pre-commit hook using Yelp's detect-secrets tool. The pre-commit hook will
scan staged changes for potential secrets before allowing a commit. If any secrets are detected above baseline, the
commit will be aborted, ensuring that no sensitive information is pushed to the repository.

No need to install locally, just make sure you have the pre-commit hook installed.

To check locally:

pre-commit run detect-secrets --all-files

To generate a new baseline, install the version of detect-secrets that's configured in .pre-commit-config.yaml
locally (using pip or brew -- just double check that you have the right version) and run:

detect-secrets scan > .secrets.baseline

ktlint

This project enforces a standard code formatting style using ktlint via the
automatic pretty-format-kotlin pre-commit hook.

The pretty-format-kotlin hook automatically formats Kotlin code with ktlint rules before committing it.

You can run ktlint for the entire project using the pre-commit like so:

pre-commit run pretty-format-kotlin --all-files

prettier

We use prettier to format our Markdown. The configuration is found in
.prettierrc.yml.

To format all Markdown files in the project, run (needed if e.g. the corresponding job is failing):

pre-commit run prettier --all-files

Note that prettier formats tables differently than IntelliJ, so you might want to disable IntelliJ's
Incorrect table formatting Markdown inspection.

Version

The NPL CLI follows a versioning scheme aligned with Noumena Platform releases.

Updating the Version

• You must manually update the version in the pom.xml file.
• For a first-time release, set the version to match the Noumena Platform version (e.g., 2025.1.2).
• For CLI patches, append a patch number starting from -1 (e.g., 2025.1.2-1).

Make sure the version you set correctly reflects the corresponding Noumena Platform release.

Old CLI

The older CLI was intended for use with Noumena Cloud. It is no longer supported and has been replaced by the new CLI.
The old CLI is still available under the GitHub releases, and is documented in the old CLI README.

Deploy Command

The deploy command allows you to deploy NPL sources to a Noumena Engine instance.

Usage

npl deploy --target <target> --sourceDir <directory> [--clear]

Where:

• [target] (required, unless defaultTarget is present in the config) is the named target from the configuration file
• [directory] (required) is the path to the directory containing NPL sources
• [--clear] (optional) clears the application contents before deployment

Configuration

The deploy command requires configuration settings that are read from a YAML file. The CLI looks for configuration in
the following locations (in order):

1. ./.npl/deploy.yml (current directory)
2. ~/.npl/deploy.yml (user's home directory)

The configuration file contains multiple named deployment targets, allowing you to quickly switch between different
environments (dev, test, prod, etc.) without changing the command.

Configuration Schema (YAML)

schemaVersion: v1
defaultTarget: target-name # Optional
targets:
  target-name:
    type: engine # Currently only 'engine' type is supported
    engineManagementUrl: http://server:port
    authUrl: http://auth-server:port/realms/your-realm # Include the realm in the URL
    username: your-username
    password: your-password
    clientId: client-id
    clientSecret: client-secret
  another-target:
    # Another target configuration
    ...

Properties for Each Target

Property	Description	Default Value
engineManagementUrl	URL of the Noumena Engine Management API	"http://localhost:12400/realms/noumena"
authUrl	URL of the authentication endpoint	"http://localhost:11000"
username	Username for authentication	(Required)
password	Password for authentication	(Required)
clientId	Client ID for authentication	"foo"
clientSecret	Client secret for authentication	"bar"

Example Configuration

A sample configuration file is available at `

Cloud login command

The cloud login command allows you to login to NOUMENA cloud with device token flow.

Usage

npl cloud login

That command will login you to the NOUMENA cloud and store the access token in the ~/.noumena folder.

Args	Default values	Can be overridden
clientId	paas	Yes
clientSecret	paas	Yes
url	https://keycloak.noumena.cloud/realms/paas	Yes

Cloud deploy command

The cloud deploy command allows you to deploy NPL sources to a NOUMENA cloud application.

Usage

npl cloud deploy --appId <applicationUUID> --sourceDir <directory>

That command will deploy your sources to the NOUMENA cloud application.

Args	Default values	Can be overridden
app	-	Yes
tenant	-	Yes
url	https://portal.noumena.cloud	Yes
sourceDir	.	Yes
authUrl	https://keycloak.noumena.cloud/realms/paas	Yes
clientId	paas	Yes
clientSecret	paas	Yes

Cloud clear command

The cloud clear command allows you to clear the contents of a NOUMENA cloud application.

Usage

npl cloud clear --appId <applicationUUID>

That command will remove your application from the NOUMENA cloud.

Args	Default values	Can be overridden
app	-	Yes
tenant	-	Yes
url	https://portal.noumena.cloud	Yes
authUrl	https://keycloak.noumena.cloud/realms/paas	Yes
clientId	paas	Yes
clientSecret	paas	Yes