Learn About

Deep workflow guides aligned to this documentation section.

Opta Local Architecture

Opta Local operating model, architecture, and execution surfaces.

general

Opta CLI Masterclass

Deep command workflows, session control, and production operator patterns.

cli

Opta LMX Masterclass

Advanced LMX runtime behavior, memory strategy, and performance tuning.

lmx

Browse all Opta Learn guides

Installation

Install Opta CLI globally via npm to activate the full local execution control plane. The CLI orchestrates daemon lifecycle, runtime routing, and every interactive or autonomous execution surface.

Use the platform selector at the top of the docs to render commands for macOS or Windows before running installation and validation steps.

Prerequisites

Before installing, make sure your system meets the following requirements:

Requirement	Minimum	Recommended
Node.js	20.0+	22.x LTS
Operating System	macOS 14+, Linux (x64/arm64), Windows 11+	macOS 15 / Ubuntu 24.04 / Windows 11
npm	10.0+	Latest

Node.js version

The CLI requires Node.js 20 or later for native fetch, structured clone, and stable WebSocket support. Check your version with node --version.

Verify your Node.js version:

Check Node.js is installed and meets the minimum version

node --version

v22.12.0

Install the CLI

Install globally via npm

This installs the opta command globally so it is available from any directory.

npm install -g @opta/opta-cli

Verify the binary is on your PATH

The opta command should now be accessible from your terminal.

which optamacos

/usr/local/bin/opta

Check the installed version

opta --version

opta/1.1.0 darwin-arm64 node-v22.12.0

Permission issues?

If you get an EACCES error during global install, either fix your npm prefix directory permissions or use a Node version manager like nvm or fnm which installs to your home directory.

Verify Installation

Run the built-in doctor command to check that your environment is correctly configured:

Run diagnostics to verify your environment

opta doctor

Opta Doctor
-----------
  Node.js     v22.12.0       ok
  npm         10.9.0         ok
  Config dir  ~/.config/opta ok
  Daemon      not running    (start with: opta daemon start)
  LMX host    not configured (set with: opta config set connection.host <ip>)

At this stage, it is expected that the daemon is not running and LMX is not configured. You will set those up in the following pages.

Smoke Test

Run a validation check to confirm the CLI initializes and responds as expected:

Check CLI status

The status command shows the current state of all components.

opta status

CLI:    v1.1.0
Daemon: stopped
LMX:    not configured

View available commands

List all top-level commands and their descriptions.

opta --help

Check configuration

View the current config file location and active settings.

opta config list

Config file: ~/.config/opta/config.json

connection.host     (not set)
connection.port     1234
daemon.autoStart    true
daemon.port         9999

No LMX connection yet

The CLI will show warnings about missing LMX configuration until you complete the LAN Setup step. This is normal at this stage.

Updating

To update to the latest version, re-run the global install command:

Update to the latest release

npm install -g @opta/opta-cli@latest

You can also check if an update is available without installing:

opta version --check

Current: 1.1.0  Latest: 1.1.0  (up to date)

Uninstalling

To remove the CLI from your workstation and optionally clear local Opta state:

Remove the globally installed CLI package

npm uninstall -g @opta/opta-cli

Optional: remove local configuration and cached local state

rm -rf ~/.config/opta ~/.local/share/optamacos

Introduction

LAN Setup