# @decantr/core

Support status: `core-supported`  
Release channel: `stable`

Low-level Decantr compiler and execution-pack foundation.

Most teams should use `@decantr/cli`, `@decantr/registry`, or `@decantr/mcp-server` directly. `@decantr/core` is part of the supported Decantr public foundation surface, but it is intentionally lower-level than the usual integration entrypoints.

## Install

```bash
npm install @decantr/core
```

## Stability

`@decantr/core` is published for advanced package consumers that need low-level execution-pack primitives. It is stable in the `2.x` line for the documented exports in this package, but it is still not the recommended first integration surface for most Decantr adopters.

## What It Exports

- execution-pack builders for scaffold, section, page, mutation, and review scopes
- execution-pack bundle compilation and pack selection helpers
- canonical pack adapter resolution used by higher-level Decantr surfaces
- execution-pack schema URLs
- markdown rendering for compiled packs
- IR and pipeline helpers used by higher-level Decantr surfaces

In the current workflow architecture, `@decantr/core` owns the canonical adapter labels used by compiled packs, while runnable greenfield bootstrap adapters are resolved in the CLI on top of those labels.

## FAQ

Most teams should start with the CLI rather than this low-level package:

```bash
npx @decantr/cli new my-app
npx @decantr/cli analyze
npx @decantr/cli check
```

For common setup, brownfield, Studio, migration, CI, and agent-alignment questions, see the user-facing [Decantr FAQ](https://github.com/decantr-ai/decantr/blob/main/docs/faq.md).

## Example

```ts
import {
  buildReviewPack,
  renderExecutionPackMarkdown,
  resolvePackAdapter,
} from '@decantr/core';

const pack = buildReviewPack({
  projectName: 'Acme Console',
  target: 'react',
  routeCount: 4,
  sections: ['overview', 'settings'],
});

const adapter = resolvePackAdapter('react', 'spa');
const markdown = renderExecutionPackMarkdown(pack);
```

## Schema Exports

This package publishes execution-pack schemas under:

- `@decantr/core/schema/scaffold-pack.v1.json`
- `@decantr/core/schema/section-pack.v1.json`
- `@decantr/core/schema/page-pack.v1.json`
- `@decantr/core/schema/mutation-pack.v1.json`
- `@decantr/core/schema/review-pack.v1.json`
- `@decantr/core/schema/pack-manifest.v1.json`
- `@decantr/core/schema/execution-pack-bundle.v1.json`
- `@decantr/core/schema/selected-execution-pack.v1.json`

## Security And Permissions

`@decantr/core` is a local execution-pack compiler and type/schema package. It does not read or write project files, call the network, spawn processes, emit telemetry, or upload source by itself. Schema URLs in emitted packs are identifiers, not network calls. See [security permissions](https://decantr.ai/reference/security-permissions.md).

## License

MIT
