@opengroundplan/core

@opengroundplan/core

The Groundplan engine, and the catalog it operates on.

Most consumers want groundplan instead. This package is the programmatic API, and it carries the data the CLI needs: catalog/, templates/, adapters/, and registry/ ship inside it.

import { loadConfig, buildPlan, apply } from '@opengroundplan/core';

loadConfig() locates that data by walking up from its own module until it finds a directory holding all four. GROUNDPLAN_HOME overrides it; every other setting is environment-driven the same way — see config.ts, which is the only place a default value is defined.

Two things worth knowing before writing a template:

• Substitution is flat — {{ name | filter }} in contents, __name__ in paths. Templates are data and never execute.
• A file that must land as .gitignore or .npmrc is stored undotted, because npm strips those names from any package tarball. The engine restores the dot.

Full documentation is in the repository.

MIT licensed.