@neutral/atlas
v1.1.0
Published
Atlas makes the context around a project navigable, helping agents and people build a better understanding.
Readme
Atlas
Atlas makes the context around a project navigable, helping agents and people build a better understanding.
Start with an overview or a question, follow an explanation into its detail, and inspect the material behind it. Trees organize these accounts; their Points carry explanations, and Facets show how another Tree's perspective matters.
This package supplies the Library, CLI, MCP server, Portal and Editor. It requires Node.js 22.23.2 or later.
Install
With Node.js installed, install Atlas globally and open a project:
npm install --global --ignore-scripts @neutral/atlas
atlas open /path/to/projectThe Editor opens in your browser. Search Atlas finds starting Points across Trees. Read an explanation beside its Tree or expand Focus reading, follow Facets into related accounts, and open cited Markdown as readable source material. Use Review sources to inspect declared local bytes and find the accounts that cite them.
Proposed changes become drafts. Review the explanation, its surrounding context, contribution reasons and any candidate Check evidence before applying the exact saved revision. Use Connect an agent for MCP setup, or Export site to share a selected reading site.
Read from code
import { openAtlas, route } from '@neutral/atlas';
const view = await openAtlas('/path/to/atlas');
if (view.status === 'ready') {
const candidates = route(view, {
query: 'offline delivery', mode: 'discover', limit: 5,
});
const first = candidates.selected[0];
if (first) {
const reading = route(view, {
...first.point.selector, orientation: 'compact', limit: 4,
});
// Read complete explanations; use reading.next to continue omitted detail.
}
}Start with your first Atlas, explore the sample Atlas, or integrate the Library. The documentation covers reading, source review and authoring. The specification defines Atlas's meaning and contracts. Validation checks structure. Authors assess source support and explanation quality.
Original material uses CC0 1.0 Universal or 0BSD. Bundled dependencies retain their own licenses.
