Installation
Install the Opta CLI globally via npm. The CLI is the primary entry point to the entire Opta Local stack -- it manages the daemon, connects to LMX, and provides the chat and task execution interfaces.
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+ or Linux (x64/arm64) | macOS 15 (Sequoia) |
| npm | 10.0+ | Latest |
node --version.Verify your Node.js version:
node --versionv22.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/cliVerify the binary is on your PATH
The opta command should now be accessible from your terminal.
which opta/usr/local/bin/opta
Check the installed version
opta --versionopta/1.0.0 darwin-arm64 node-v22.12.0
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:
opta doctorOpta 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 quick smoke test to confirm the CLI loads and responds correctly:
Check CLI status
The status command shows the current state of all components.
opta statusCLI: v1.0.0 Daemon: stopped LMX: not configured
View available commands
List all top-level commands and their descriptions.
opta --helpCheck configuration
View the current config file location and active settings.
opta config listConfig file: ~/.config/opta/config.json connection.host (not set) connection.port 1234 daemon.autoStart true daemon.port 9999
Updating
To update to the latest version, re-run the global install command:
npm install -g @opta/cli@latestYou can also check if an update is available without installing:
opta update --checkCurrent: 1.0.0 Latest: 1.1.0 (update available)
Uninstalling
To remove the CLI and its configuration:
# Remove the global package
npm uninstall -g @opta/cli
# Optionally remove config and data
rm -rf ~/.config/opta
rm -rf ~/.local/share/opta