Open App

Installation

Install the WyrdOS CLI, check your version, and understand where it lives in the monorepo.

The WyrdOS CLI is distributed as the @wyrdos/cli npm package from this monorepo.

Requirements

  • Node.js: version 18 or newer (node -v).
  • npm, pnpm, or yarn for installing the package.

Install globally

For most developers and operators, a global install is the easiest way to use the CLI:

npm install -g @wyrdos/cli

wyrdos --help

This makes wyrdos available on your PATH so you can call it from any directory.

Run via npx

If you prefer not to install globally, you can run the CLI using npx:

npx @wyrdos/cli --help

This will download and run the published CLI version without permanently installing it.

Version check

To confirm that the CLI is installed and to see which version you are running:

wyrdos --version

In CI or scripted environments, prefer an explicit version in package.json so you control when the CLI is upgraded:

{
  "devDependencies": {
    "@wyrdos/cli": "x.y.z"
  }
}

Where the CLI lives in this repo

In the WyrdOS monorepo, the CLI package lives at:

  • packages/cli – source, tests, and build pipeline

The published npm package is built from this directory and exposes:

  • the wyrdos binary
  • a public program export that the docs generator uses to stay in sync with the actual commands