@project-orchestrate/core
v0.4.1
Published
File format, validation, indexing and mutations for Project Orchestrate: project state as Markdown and YAML inside a repository.
Maintainers
Readme
@project-orchestrate/core
The file-format library behind Project Orchestrate, a local-first project control tool for agent-heavy software development.
Project state lives as plain Markdown with YAML frontmatter in a .orchestrate/ directory inside a repository. This package parses that directory, validates it against its own schema.yaml, builds the derived index, and performs every mutation (creating and updating tickets, comments and session records) under the same rules the desktop app and the agent tools use. It has no user interface and starts no server.
Most people do not install this package directly. It is a dependency of @project-orchestrate/mcp, which gives coding agents their Orchestrate tools.
Requirements
Node 22 or newer. The package is ESM only.
Use
import { loadProject, validateProject } from '@project-orchestrate/core';
const project = loadProject('/path/to/repo');
const problems = validateProject(project);The format is specified in SPEC.md in the source repository.
Licence
AGPL-3.0-only. This is a derived work; NOTICE carries the attribution. The TypeScript source ships in src/ alongside the compiled dist/.
