Generated CLI capabilities

This page describes BC Atlas 0.7.0. Run npm run docs after a capability changes.

Commands by feature area

Set up a project; in VS Code, the BC Atlas extension shows everything in the editor.

Command	Invocation	Purpose
`setup`	`bca setup [app-root]`	Set up BC Atlas for a project step by step: .bca.json, features, Git hooks, pipelines, schedules, and sync.
`setup.plan`	`bca setup plan [app-root]`	Detect the project and list setup questions with recommended answers.
`setup.apply`	`bca setup apply [app-root]`	Write .bca.json, Git hooks, and a pipeline from setup answers.
`setup.agent`	`bca setup agent [app-root]`	Add a /bca-setup command for your AI agent that runs the guided setup through the CLI.

Gate CI on architecture health and keep a target architecture in place.

Command	Invocation	Purpose
`check`	`bca check [app-root]`	Score architecture health and fail CI on cycles, policy violations, or diagnostics.
`architecture`	`bca architecture [app-root]`	Find a target architecture (components, layers, allowed dependencies), list every dependency that points the wrong way with how to resolve it, and enforce it with a baseline.
`refactor.move`	`bca refactor move [app-root]`	Move an AL object to another component: its file goes to the component's folder (cut out of a shared file), its namespace becomes the component's, and referencing files get the using they need.
`refactor.surface`	`bca refactor surface [app-root]`	Lock the public surface of components: objects no other component uses get Access = Internal, and .bca.json lists what others use in exposes.

Write what the app shows as files, and user guides from AL UI tests.

Command	Invocation	Purpose
`export`	`bca export [app-root]`	Write files: the BC Atlas pages as one offline HTML file, the Markdown report, the 3D explorer, the object catalog, or one diagram view.
`docs.list`	`bca docs list <test-root>`	List documented UI-test scenarios.
`docs.show`	`bca docs show <test-root>`	Show one scenario, its prerequisites, and its diagnostics.
`docs.validate`	`bca docs validate <test-root>`	Validate IDs, tags, links, and prerequisite cycles.
`docs.generate`	`bca docs generate <test-root>`	Generate user guides or test cases with flow diagrams as Markdown, HTML, DITA, Azure DevOps CSV, or BPMN.
`docs.set`	`bca docs set <test-root>`	Add or replace documentation metadata in AL source.
`docs.unset`	`bca docs unset <test-root>`	Remove documentation metadata from AL source.
`docs.automation`	`bca docs automation <test-root>`	Print a CI pipeline that keeps generated guides in sync.
`docs.glossary`	`bca docs glossary`	List supported documentation tags and prerequisite types.

Connect BC Atlas to Git hooks, pipelines, schedules, and AI agents.

Command	Invocation	Purpose
`run`	`bca run [app-root]`	Run the features configured for a trigger (Git hook, pipeline, schedule) and sync their output.
`update`	`bca update [app-root]`	Check for a new BC Atlas version, show what changed, and update it together with the generated setup files.
`mcp`	`bca mcp`	Start the Model Context Protocol server on stdio for AI agents.

`--view`	Writes
`app`	The BC Atlas pages as one offline HTML file to share: every page, the diagrams, the 3D explorer, and the docs
`report`	Markdown report (README.md) with health, diagrams, and an optional object catalog
`explorer`	Interactive 3D dependency explorer (HTML), replayable over Git history, or its graph as JSON
`catalog`	One linked Markdown page per AL object

View	Shows
`project`	AL objects grouped into role lanes (Data, UI, Services, ...)
`module`	Aggregated namespace or folder dependencies
`object`	One object with incoming and outgoing neighbors
`data`	Tables with reads, writes, relations, and extensions
`call`	Procedure and trigger call graph
`boundary`	Dependencies crossing a namespace, folder, app, or object
`contracts`	Interfaces and their direct or enum implementations
`events`	Event publishers and subscribers
`ui`	Pages, source tables, parts, actions, and navigation
`workflow`	Calls, events, and data mutations traced from entry points

For all options and examples, read the CLI reference.