NPL CLI

The NPL CLI is a command line tool to support the development of projects written in Noumena Protocol Language (NPL). It offers several useful commands for interacting with your NPL projects.

How to install

Homebrew (MacOS)binary (MacOS/Linux)binary (Windows with WSL)Windows without WSL

Simply run:

brew install NoumenaDigital/tools/npl

[!NOTE] If you have previously installed the NPL CLI using the curl command, you may need to remove the old version before installing the new one. You can do this by running rm -rf ~/.npl and then reinstalling the new version with brew.

Download and install the NPL CLI using the following command:

curl -s https://documentation.noumenadigital.com/get-npl-cli.sh | bash

You may have to restart the terminal to ensure the CLI is available in your PATH after installing the NPL CLI.

Alternatively, download the latest release here and add it to your $PATH.

Download and install the NPL CLI using the following command:

curl -s https://documentation.noumenadigital.com/get-npl-cli.sh | bash

You will need to manually add the npl executable to your PATH. The script above will not do that for you.

Download and install the latest .exe executable here.

Commands

To see a description of how to use each command, run npl help

Command	Description
`npl version`	Displays the current version of the NPL CLI
`npl help`	Displays help information for the NPL CLI
`npl init`	Initializes a new project
`npl check`	Checks the NPL for compilation errors and warnings
`npl test`	Runs the NPL tests
`npl puml`	Generates a puml diagram from NPL source
`npl openapi`	Generates the openapi specs for NPL protocols
`npl deploy`	Deploys NPL sources to a configured NOUMENA Engine target
`npl cloud help`	Displays help information for the NPL CLI cloud commands
`npl cloud login`	Handles the NPL CLI login to NOUMENA Сloud
`npl cloud logout`	Handles the NPL CLI logout from NOUMENA Cloud
`npl cloud deploy npl`	Deploys NPL sources to a NOUMENA Cloud Application
`npl cloud deploy frontend`	Deploys frontend build sources to a NOUMENA Cloud Application
`npl cloud clear`	Deletes NPL sources and clears protocols from the database from the NOUMENA Cloud Application

Supported Operating Systems and architectures

	ARM 64	AMD 64
MacOS	Yes	Yes
Linux	Yes	Yes
Windows	Yes	Yes

Model Context Protocol (MCP) server

Once you've installed the CLI, you can use it in MCP mode with your local AI tools.

Install in VS Code

Simply add npl-cli to your MCP configuration file, e.g.

{
  "mcpServers": {
    "npl-cli": {
      "name": "NPL CLI",
      "command": "npl",
      "args": ["mcp"]
    }
  }
}