@miao-ai/node

The Node.js host for Miao Runtime. It resolves a platform Runtime package, manages its process lifecycle, and exposes the full transport-independent client API.

npm install @miao-ai/[email protected]

import { Miao } from "@miao-ai/node";

const miao = await Miao.spawn({ profile: "stable", dataDir: ".miao" });
try {
  console.log(await miao.runtime.describe());
} finally {
  await miao.close();
}

Node.js 20 or newer is required. Version 0.1.1 platform packages cover validated macOS arm64, Windows x64, and Linux x64 hosts. macOS x64 and Linux arm64 follow after native validation. Runtime packages are optional dependencies selected by npm; do not install with --omit=optional.

On Windows x64, or on Linux hosts without usable bubblewrap isolation, only a new Runtime data directory starts in disclosed full-access compatibility mode. Existing settings are not overwritten, and explicit restricted modes still fail closed. Do not run untrusted Apps in compatibility mode.

Secrets belong in secrets or the child environment, never in binaryArguments. Runtime protocol output is reserved for stdout; diagnostics are bounded, redacted, and delivered through stderr.

Before starting a real Agent, persist the active Provider and its api_key_env name in the selected dataDir/settings.json, then inject the matching value through secrets. Passing a secret alone does not select a Provider or rewrite Settings. With no credential declaration the Runtime keeps its offline management surface; a declared but missing environment variable fails closed.

Runtime 0.22.1 and SDK 0.1.1 deliberately use independent SemVer. The descriptor's protocol, schema, operations, and features determine compatibility.

Licensed under MIT OR Apache-2.0.