@atolis-hq/corum
v0.1.71
Published
<div align="center">
Readme
Corum is a Git-native, extensible design graph for software architecture. It models components as nodes with typed edges, and exposes the graph through MCP tools so AI assistants can reason about and evolve your architecture. Corum provides several out of the box schemas (such as APIs, domain models, events, schemas, fields) but can be customised to model any data structure. The graph enables modelling data lineage at object and field level, and the branching model enables multiple simultaneous designs with cross branch impact analysis.
Install
npm install -g @atolis-hq/corumOr run without installing:
npx @atolis-hq/corum <command>Windows: If you see an "execution policy" error in PowerShell, run this once:
Set-ExecutionPolicy RemoteSigned -Scope CurrentUserThis is a standard one-time setup step for Node.js development on Windows. Alternatively, npx @atolis-hq/corum <command> works without any setup on all platforms.
Update
npm update -g @atolis-hq/corumQuick Start
Scaffold a new project in the current directory:
corum initThis creates .corum/config.yaml, scaffolds a graph at .corum/graph/, and downloads the official template packs (core, domain, rest, messaging). Then start the MCP server:
corum mcpIf you only want the web UI:
corum webDocumentation
- Getting started - install, initialise, connect an agent
- Concepts - nodes, edges, clusters, IDs, lineage, branches
- Templates and packs - defining and extending node types
- Importing - OpenAPI, AsyncAPI and extractor output
- Working with agents - reading and changing the graph
- MCP tools, CLI, Configuration - reference
Contributing
See DEVELOPMENT.md for build, test, and local development instructions.
Issues & Feature Requests
Found a bug or have an idea for Corum? Open an issue — bug reports and feature requests are both welcome.
License
Corum is licensed under the Apache License 2.0.
