Skip to content

CLI Overview

The openlogos CLI manages the project lifecycle — from initialization through phase progression, change management, and test verification.

Terminal window
npm install -g @miniidealab/openlogos@latest

Verify:

Terminal window
openlogos --version
# 0.16.0

After upgrading the CLI, run openlogos sync in each existing project to refresh its guard, hooks and Skills.

OptionDescription
--help, -hShow the help message
--version, -vShow the version number
--format jsonStructured JSON output (supported by most read and gate commands, e.g. status, next, verify, merge, change-lint, impact)

Apart from init (and detect, which also works elsewhere), commands must be run from the project root (the directory containing logos/logos.config.json).

CommandDescription
initInitialize a new OpenLogos project structure
adoptOnboard an existing project (bootstrap: adopted)
syncRegenerate AI instruction files, guard, hooks and Skills from the current config
statusShow project phase, active proposal step and suggestions
nextShow the single most actionable next step (--auto for full-auto)
watchStream live derived dev-flow state (read-only)
flow showShow the built-in or overlay-resolved dev-flow orchestration
detectShow CLI version and project detection information
indexGenerate an AI-ready prompt to rebuild the logos-project.yaml resource index
moduleManage project modules (list / add / rename / remove / set-product-type)
feature list / feature-backfillList feature groups; generate a prompt to backfill them
CommandDescription
verifyVerify test results against test case specs (Gate 3.6)
deploy-doneRecord controlled deployment completion (Gate 3.7)
smokeVerify post-deployment health against smoke specs (Gate 3.8)
launchActivate change management after verification passes
CommandDescription
changeCreate a change proposal and set the active-change guard
change-lintRead-only delivery check of proposal, tasks and deltas (L0–L9)
mergeMerge spec deltas into the main documents in one atomic call; amend an already-merged proposal
slice planWrite [code] slices and TEST_SLICE_MANIFEST.json from slices.json
archiveArchive a completed change proposal and release the guard
CommandDescription
lint-specsRead-only structural check of test specs (duplicate IDs / table columns / ID format)
impactClassify a git change range as lifecycle-only bookkeeping (for CI)
ignore / exemptManage paths kept out of version control, and committed paths that do not need a proposal (add / remove need host approval)

OpenLogos projects have two lifecycle states:

┌───────────────────────────────────────────────────────────────┐
│ │
│ openlogos Phase 1 → 2 → 3 openlogos openlogos │
│ init (AI + Skills) verify launch │
│ ────────► ┌──────────────────┐ ──────────► ──────────► │
│ │ "initial" │ Gate 3.6 │
│ │ (No change │ PASS │
│ │ proposals │ │
│ │ required) │ │
│ └──────────────────┘ │
│ │
│ ┌──────────────────┐ │
│ │ "launched" │ ◄── openlogos change <slug> │
│ │ (Change │ ──► openlogos merge <slug> │
│ │ proposals │ ──► openlogos archive <slug> │
│ │ required) │ │
│ └──────────────────┘ │
└───────────────────────────────────────────────────────────────┘
  • initial — First development cycle. AI follows the phase progression (Phase 1 → 2 → 3) freely, without requiring change proposals. Ends with openlogos verify (Gate 3.6 must PASS).
  • launched — After openlogos launch. All modifications to existing documents must go through a change proposal (change → merge → archive).

The development lifecycle progresses through 13 phases. The status command tracks 11 of them by scanning logos/resources/ directories; Phase 3-5 produces code in the project source tree and is validated indirectly through Phase 3-6 verification.

PhaseDirectorySuggested AI prompt
Phase 1 · Requirementslogos/resources/prd/1-product-requirements/”Help me write requirements”
Phase 2 · Product Designlogos/resources/prd/2-product-design/”Do product design based on requirements”
Phase 3-0 · Architecturelogos/resources/prd/3-technical-plan/1-architecture/”Help me design the technical architecture”
Phase 3-1 · Scenario Modelinglogos/resources/prd/3-technical-plan/2-scenario-implementation/”Help me draw S01 sequence diagram”
Phase 3-2 · API Designlogos/resources/api/”Help me design the API”
Phase 3-2 · DB Designlogos/resources/database/”Help me design the database”
Phase 3-3 · Deployment Planlogos/resources/prd/3-technical-plan/3-deployment/”Help me design the deployment plan”
Phase 3-4a · Test Caseslogos/resources/test/”Help me design test cases”
Phase 3-4b · Orchestrationlogos/resources/scenario/”Help me design orchestration tests”
Phase 3-5 · Code Implementation(project source tree)“Implement S01 based on the specs”
Phase 3-6 · Verificationlogos/resources/verify/Run tests, then openlogos verify
Phase 3-7 · Deployment Execution(deployment report)Execute deployment with human authorization
Phase 3-8 · Smoke Testlogos/resources/verify/smoke-report.mdopenlogos smoke after deployment

Phase 3-5 is the core implementation step where AI generates business code + test code based on the full specification chain (sequence diagrams, API YAML, DB DDL, test case specs). Each batch of generated code must include an OpenLogos reporter that writes results to logos/resources/verify/test-results.jsonl. This phase does not have a dedicated logos/resources/ directory because code output goes directly into the project source tree.

Terminal window
# 1. Initialize
openlogos init my-project
cd my-project
# 2. Work through phases with AI
# Phase 1 → 2 → 3-0 → 3-1 → 3-2 → 3-3 (AI loads Skills automatically)
openlogos status # check progress at any time
openlogos next # ask for the single next action
# 3. Implement code + test code (Phase 3-5)
# AI generates business code and test code from full specification chain
# Test reporter writes results to logos/resources/verify/test-results.jsonl
# 4. After all phases complete, verify test coverage
openlogos verify # Gate 3.6 must PASS
# 5. Activate change management for future iterations
openlogos launch
# 6. For future changes, use the Delta workflow
openlogos change fix-redirect-bug
# ... AI fills proposal + tasks, then writes deltas ...
openlogos change-lint # must exit 0 before handing over
openlogos merge fix-redirect-bug # one atomic call, writes SPEC_MERGED
openlogos slice plan --file slices.json # slice-planner writes [code] slices
# ... AI implements code + tests ...
openlogos verify # Gate 3.6
openlogos archive fix-redirect-bug

In semi-auto mode, merge, verify, deployment, smoke, archive and git push are run only after you explicitly authorize them; openlogos next --auto grants a standing authorization for the whole chain (see next).