@oahl/cli

The command-line interface for the Open Agent Hardware Layer (OAHL).

This tool provides an interactive wizard for hardware owners to easily configure their hardware nodes, set up safety policies, and expose devices to AI agents without having to write code or manually edit JSON files.

Installation

npm install -g @oahl/cli

Usage

Initialize a new Node

Run the interactive setup wizard to generate your oahl-config.json:

oahl init

The wizard will ask you for:

• Your node name and provider details
• The type of hardware you are connecting (e.g., USB Camera, RTL-SDR)
• Privacy and security policies for the device

Scaffold a new Adapter

Generate a starter adapter package:

oahl create-adapter my-device

This creates a ready-to-edit adapter with a valid OAHL interface implementation.

Run conformance checks

Run the OAHL core conformance suite from your monorepo root:

oahl conformance

Or specify a workspace path:

oahl conformance --workspace /path/to/oahl

Configure with Terminal UI (TUI)

Open an interactive terminal UI to manage node settings, plugins, devices, and access policies:

oahl tui

Use a custom config path if needed:

oahl tui --config ./my-oahl-config.json

In TUI, use Import detected devices from plugins to auto-populate devices from currently installed adapters, then edit access policy/visibility for each imported device.

Scan connected USB/serial ports

Scan currently connected devices and get adapter suggestions:

oahl scan-ports

Output JSON for scripting/tooling:

oahl scan-ports --json

The scan output includes detected IDs, port type, suggested adapter, capability hints, and config snippets to accelerate adapter creation.

What is OAHL?

OAHL is an open-source framework that lets hardware owners safely expose physical capabilities (like taking pictures or scanning radio frequencies) to remote AI agents.

For the full documentation, visit the main OAHL repository.