Skip to content

CLI

The published package is @atlante/cli. It requires Node.js 22 or later.

Terminal window
npx @atlante/cli --help
npx @atlante/cli --version

atlante init

Section titled “atlante init”

Scaffold a project configuration, register the OpenCode adapter, and build the initial artifacts.

Terminal window
npx @atlante/cli init [path]
npx @atlante/cli init [path] --preset <package-locator>
npx @atlante/cli init [path] --force
  • path is a project directory and defaults to the current directory.
  • --preset <locator> selects the preset to extend instead of the default @atlante/pack.
  • --force overwrites an existing atlante.jsonc and removes the alternate atlante.json.

init validates the selected preset before changing files. It creates or updates opencode.jsonc without replacing existing host settings and runs a build.

atlante validate

Section titled “atlante validate”

Validate the source document, selected resources, template schemas, values, and template-owned input without rendering or publishing artifacts.

Terminal window
npx @atlante/cli validate [path]

path can be a project directory or an explicit atlante.jsonc or atlante.json file. It defaults to the current directory.

A successful command prints:

validated atlante.jsonc

atlante build

Section titled “atlante build”

Validate, render, and atomically publish host-neutral artifacts.

Terminal window
npx @atlante/cli build [path]
npx @atlante/cli build [path] --watch

--watch keeps the process running and rebuilds when the selected configuration or resources change. See watch for changes.

A successful command prints:

built .atlante/artifacts

Exit status

Section titled “Exit status”
  • 0 means the command completed without errors.
  • 1 means validation or build failed.

Warnings do not make a successful build fail. A failed build publishes no partial artifact tree.

Path behavior

Section titled “Path behavior”

When a path is a directory, Atlante discovers atlante.jsonc or atlante.json. When a path is one of those files, Atlante reads it directly. If both files are present in a discovered project, the CLI reports ambiguous-config rather than choosing one silently.