CLI Overview
What the WyrdOS CLI is, who it is for, and how it relates to the REST API.
The WyrdOS CLI is a command-line client for developers, operators, and AI agents who want a fast, scriptable way to work with WyrdOS.
Instead of talking directly to individual REST endpoints, the CLI exposes:
- Resource – thin, spec-backed CRUD wrappers for core resources like organisations, containers, zones, actions, and pages.
- Pages – first-class support for pages and their relationships to containers.
- Operational – higher-level views like
auth check,context, andplan todaythat answer “what matters now?” for humans and agents. - Engines – read-only views into engines, goals, values, principles, pillars, risks, and strategic context.
You can always fall back to the REST API directly, but the CLI is the primary interface for:
- scripting WyrdOS behaviour in CI, cron jobs, or one-off scripts
- giving AI agents a structured, reliable surface for reading and writing state
- exploring and debugging your workspace from the terminal
If you are new to WyrdOS, start with:
/getting-started/01-start-guide– core concepts and workspace setup- the Installation, Authentication, and Output & errors pages in this CLI section
Then move on to:
- Resource when you need direct access to organisations, containers, zones, actions, or pages.
- Pages when you want to work with written content and container–page relationships.
- Operational when you want to understand current context, inboxes, or today’s focus.
- Engines when you need to understand the strategic “why” behind your workspace.
© 2026 Wyrdos
All rights reserved.
All rights reserved.