Commands Reference

Complete reference for all Noorle CLI commands.

Command Structure

noorle [GLOBAL_COMMAND]
noorle plugin [SUBCOMMAND]

Global Commands

Core commands available at the root level:

noorle login

Authenticate with Noorle Platform using OAuth 2.0 device flow.

noorle login

Process:

1. Displays a device code and URL
2. Opens browser automatically (or provides link)
3. You authorize in browser
4. CLI receives token and stores it

Token Storage: ~/.noorle_token

noorle logout

Clear stored authentication tokens.

noorle logout

Effects:

• Removes stored authentication tokens
• Requires re-authentication for deployment

noorle check-update

Check if a newer version of the CLI is available.

noorle check-update

noorle --help

Display help information about the CLI and available commands.

noorle --help

noorle --version

Display the current version of the CLI.

noorle --version

Plugin Subcommands

Plugin management commands under noorle plugin:

noorle plugin init

Initialize a new plugin project from a template.

# Interactive template selection
noorle plugin init <project-name>

# Direct template specification
noorle plugin init <project-name> --template <template-name>

Arguments:

• <project-name> - Name for your project (creates directory)

Options:

• --template <name> - Skip interactive selection

Examples:

noorle plugin init my-plugin --template rust
noorle plugin init weather-api --template python
noorle plugin init data-processor  # Interactive selection

noorle plugin list-templates

List all available plugin templates from the platform.

noorle plugin list-templates

Output: Shows available templates with descriptions.

noorle plugin prepare

Install and check dependencies required for building.

noorle plugin prepare

Installs:

• wasmtime - WebAssembly runtime
• wkg - WIT package manager
• wasm-tools - WebAssembly utilities
• Rust toolchain - Required for tools above

noorle plugin build

Build the current plugin project.

noorle plugin build

Process:

1. Runs the build.sh script from template
2. Produces dist/plugin.wasm
3. Validates WebAssembly output

Requirements:

• Must be run in project directory
• Dependencies installed (prepare)

noorle plugin pack

Create a .npack archive from built plugin.

noorle plugin pack

Output: dist/plugin.npack

noorle plugin deploy

Upload plugin to the Noorle Platform.

noorle plugin deploy

Requirements:

• Authentication (noorle login)
• Built plugin (noorle plugin build)

noorle plugin publish

Build and deploy plugin in one command.

noorle plugin publish

Equivalent to:

noorle plugin build
noorle plugin deploy

noorle plugin validate

Validate the plugin's YAML configuration.

noorle plugin validate

Command Reference Table

Command	Description
login	Authenticate with platform
logout	Clear authentication tokens
check-update	Check for CLI updates
plugin init	Create new plugin from template
plugin list-templates	Show available templates
plugin prepare	Install/check dependencies
plugin build	Build current plugin
plugin pack	Create .npack archive
plugin deploy	Upload to platform
plugin publish	Build and deploy
plugin validate	Validate YAML config
--help	Display help information
--version	Show CLI version

Environment Variables

Variable	Purpose	Example
RUST_LOG	Enable debug output	RUST_LOG=debug noorle plugin build
NOORLE_INSTALL	Custom install directory	NOORLE_INSTALL=/opt noorle

Exit Codes

• 0 - Success
• 1 - General error
• 2 - Invalid arguments

Usage Patterns

Development Cycle

# Initial setup
noorle login
noorle plugin init my-plugin --template rust
cd my-plugin
noorle plugin prepare

# Build and test
noorle plugin build

# Deploy when ready
noorle plugin deploy

# Or quick iteration
noorle plugin publish

Getting Help

# General help
noorle --help

# Plugin commands help
noorle plugin --help

# Specific command help
noorle plugin init --help