Skip to content

Latest commit

 

History

2,272 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logics Manager icon

logics-manager


CI License Version VS Code TypeScript Vitest

logics-manager is a local workflow runtime for projects that keep their delivery memory in Markdown.

The core product is the CLI. It creates, promotes, validates, audits, and closes the logics/* documents that describe work:

request -> backlog item -> task -> implementation

Everything else in this repository is a client around that runtime:

  • the VS Code extension embeds the same local viewer inside VS Code;
  • the MCP server gives assistants a bounded tool API over the same CLI;
  • the npm package and Python package are distribution paths for the same runtime.

The source of truth stays in your repository. Logics documents are plain Markdown, versioned with git, readable in reviews, and reusable by humans or AI assistants across sessions.

The Viewer

A local board over your logics/* documents. The columns are the three stages work moves through — requests, backlog items, tasks — each showing what is live and folding what is done. Product briefs, roadmaps, architecture decisions and the rest are a reference index beside them: reachable, but not competing with the queue. Filterable, searchable, and groupable by whatever you're deciding. It runs standalone (logics-manager view) or embedded in the VS Code extension.

The board: three flow columns — requests, backlog, tasks — each headed with how many are live against how many are done, beside a reference index of product briefs and roadmaps

Reading a document lists its sections down the left, marks where you are in them, and gives the document itself the rest of the width — its tables, chain diagrams and code are as much of it as its prose.

The reader: a request opened with its fifteen sections listed down the left, its linked workflow drawn as a chain, and the document filling the width beside them

Corpus insights summarizes the shape of the corpus and the signals worth acting on, and Validation health answers whether anything blocks — with a repair action where fixes are automatic.

Corpus insights: how many signals need attention across the corpus, the operator actions that address them, the corpus by stage and state, and the chains in flight

The same documents read as a list instead of columns, grouped by type, status, theme or nothing at all, sorted, and dated.

The board in list mode: one row per document under collapsible group headers, each row carrying its status, linked-document count and age

The captures above are produced by scripts/dev/capture-readme-media.mjs against this repository's own corpus; docs/media/PROVENANCE.md records the framing.

What It Solves

AI-heavy projects often lose context between chats, agents, and implementation passes. Logics turns that context into durable project artifacts:

  • request: the problem, need, and acceptance criteria;
  • backlog item: a scoped delivery slice;
  • task: executable implementation work;
  • product brief: product framing and intent;
  • roadmap: versioned long-term plan such as 0.1 -> 0.2 -> 1.0;
  • ADR: architectural decisions;
  • spec: behavioral contract.

The result is a repo-local memory layer that reduces re-explaining, keeps implementation grounded, and gives every assistant or human the same inspectable workflow state.

Product Shape

logics-manager has one core and several integrations:

Layer Purpose
CLI runtime Canonical workflow engine for creating, promoting, auditing, repairing, and closing Logics docs.
VS Code extension VS Code host for the canonical local viewer, with editor lifecycle and focus commands.
MCP server Assistant-facing adapter that exposes bounded Logics tools without giving agents a shell.
Bundled agent skills Eight reusable skills, installed into Claude Code / Codex / Hermes / Antigravity homes via logics-manager skills install, re-synced automatically on update. See docs/cli.md.
npm / Python packaging Installation paths for the same CLI/runtime.

The CLI owns the behavior. The extension and MCP server call into it instead of reimplementing workflow logic.

Quick Start

The recommended install path is the npm package. It bundles the CLI runtime in a self-contained launcher that works the same on macOS, Linux, and Windows / WSL:

npm install -g @grifhinz/logics-manager
logics-manager --help

Install the CLI from this repository when developing locally:

python3.11 -m pip install .
logics-manager --help

Python install paths (legacy, not recommended)

Deprecated. pip and pipx installs are still published for backwards compatibility, but they are no longer the supported path: they break on PEP 668 distros, on WSL (slow /mnt/<drive> IO and gio opener failures), and on Python interpreters that diverge from the build matrix. Prefer the npm install above. The PyPI release will keep shipping — we only stop recommending it for end users.

PyPI:

python3.11 -m pip install logics-manager

Isolated user-level install via pipx (still published, no longer recommended; reach for npm if you hit PEP 668 or externally-managed Python errors):

pipx install logics-manager

Initialize or check a repository:

logics-manager bootstrap --check

bootstrap writes the logics/ tree and the managed section of AGENTS.md/LOGICS.md; the only things it removes are the bridge files older versions generated (.claude/commands/logics-*.md, .claude/agents/logics-*.md, logics/skills/). Your own .claude/ settings and files are untouched -- see docs/cli.md for the full list.

Create the first workflow document:

logics-manager flow new request --title "Improve onboarding"

Create a longer-term plan when the work spans several versions:

logics-manager flow roadmap propose --title "Improve onboarding" --milestone "0.1: MVP" --milestone "0.2: Guided setup"

Validate the workflow corpus:

logics-manager lint --require-status
logics-manager audit

Obsidian-friendly Markdown usage

Logics docs are plain Markdown, so you can open either the repository root or the logics/ directory as an Obsidian vault for reading, search, backlinks, and graph navigation. The local .obsidian/ workspace directory is ignored by Git, so vault layout, plugin choices, and workspace state stay local to each user.

Recommended setup:

  • Open the full repository when you want README, source files, and Logics docs in one vault.
  • Open logics/ when you want a focused workflow-document vault.
  • Use Obsidian for navigation, review, notes, and light Markdown edits.
  • Use logics-manager flow ... for lifecycle changes such as create, promote, closeout, finish, and status transitions.

Safe editing rules:

  • Do not hand-edit Logics indicators such as Status, Progress, Understanding, Confidence, lineage links, Mermaid signatures, or generated done/closeout evidence.
  • Keep canonical Logics references as repo-relative paths or refs. obsidian sync adds [[wikilink]] navigation hints as a derived, opt-in projection — Logics Manager parsing never requires them, and canonical files under logics/ are never rewritten by hand from this.
  • Frontmatter, tags, and aliases are not written to canonical files; they only ever exist in the opt-in projection, generated deterministically and non-destructively, and validated against the canonical Logics doc type, ref, status, and title.

After editing workflow docs in Obsidian, validate from the repository root:

logics-manager lint --require-status
logics-manager audit --group-by-doc

Documentation

Full documentation lives in docs/, split by surface so each topic stays readable on its own. GitHub renders every page and the links below are clickable.

Topic What's inside
Core CLI Commands, agent cookbook, local browser viewer, CLI contracts, closing work, notes.
Project i18n contract Optional source-only and multi-locale catalog governance, validation, viewer integration, and migration.
VS Code Extension Features, installation, development from source, command palette.
MCP For Assistants Assistant-facing tool surface, connector plans, assistant model.
Onboarding Prompts Starting-point prompts for need, framing, orchestration, execution.
Development & Validation Requirements, runtime compatibility, validation commands, Windows validation, accessibility.
Deploy / Release (VSIX) Versioning, changelog validation, packaging, release steps.

A short tour of each surface:

  • The CLI is the canonical workflow engine. It creates requests, backlog items, tasks, product briefs, roadmaps, and ADRs; promotes and splits them; closes work with consistency checks; lints and audits traceability; exports indexes, context packs, and graph data; and serves both the local browser viewer and the bounded MCP tool surface. It also builds prompt packs for external image generators with design prompt, per asset kind, so a sheet and a single hero image never receive the same instructions. See docs/cli.md.
  • The VS Code extension hosts the same local viewer inside VS Code and keeps editor-specific commands limited to viewer lifecycle and focus shortcuts. See docs/vscode.md.
  • The MCP server gives assistants a bounded tool API over the same CLI without arbitrary filesystem or shell access. See docs/mcp.md.

Security

See SECURITY.md for supported versions and vulnerability reporting guidance. Do not publish suspected vulnerabilities in public issues until they are triaged; use GitHub's private vulnerability reporting or a private security advisory draft for this repository.

About

Workflow orchestration toolkit and CLI for managing Logics docs, validation, MCP access, and VS Code integration.

Topics

Resources

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages