Skip to content

getting-started.md

Latest commit

 

History

History
88 lines (62 loc) · 3.48 KB

getting-started.md

File metadata and controls

88 lines (62 loc) · 3.48 KB
Raw

Getting started

简体中文

This guide gets you to the first real Bearing governance loop.

Prerequisites

  • macOS for the verified Preview path.
  • Node.js release line selected by the current release candidate.
  • A coding agent that can read repository guidance, install a package, and integrate a skill.
  • A Git repository you actively work on.
  • The supported Matt-native local Markdown Map and Ticket workflow, or a willingness to create one before expecting strong first value.

Install

npx --yes @lagrangee/bearing@<resolved-version> install

Have the Agent verify <resolved-version> and its package identity first. The exact candidate's bearing install primitive installs the complete Global Kit and canonical absolute CLI locator; it does not configure a repository or start Portal. Bare bearing shows help only. Explicit bearing uninstall removes only package-managed Global Kit targets and preserves the Project Catalog and repository state.

For later Global Kit maintenance, run bearing update. It performs one npm latest update check and verifies the exact candidate before comparison. A newer version is displayed as Update available: <current> → <target> and requires a separate confirmation before mutation. Declining or cancelling changes nothing. Global Kit Update preserves existing owned surface links and is independent from Agent-guided Repository Update, Repository Configuration, and Portal start. Use an exact package candidate entry when you need to select a version explicitly.

The user-level Bearing skill remains available for an explicit Bearing or Repository Configuration request in any repository. A configured repository pointer uses context, not a repeated CLI preflight: explicit Bearing concepts, reliable continuation, or materially relevant planning and governance work can nominate Bearing. Ordinary code work and working-directory context alone do not.

Enable one repository

In your target repository, ask your agent:

Set up Bearing for this project. Use the existing Map and Tickets as work context, and guide me through the minimum governance baseline.

If you use the CLI directly, prefer help output from the installed version:

bearing --help
bearing configure inspect --repo .
bearing configure

Establish the minimum baseline

The useful baseline is intentionally small:

  1. Project Summary: what the project is, what is currently true, and what is out of bounds.
  2. Roadmap: one active long-horizon outcome.
  3. Milestone Gate: the focused decision boundary for current progress.
  4. Effort: one binding from existing Map or Ticket work to the Roadmap and Gate.

Bearing should ask before accepting direction. If the agent silently invents strategic truth, stop and ask it to surface assumptions as decisions.

Complete the first governance loop

Bring one real request:

Before we start, check this against the current direction, accepted decisions, and active work. Surface any conflict before acting.

The loop succeeds when the agent either:

  • explains why the request fits the current direction and active work; or
  • identifies a material conflict and gives explicit decision paths before implementation.

Inspect the shared picture

bearing cache rebuild --repo .
bearing provider verify --all --repo .
bearing inspect project --repo .
bearing portal

Portal is read-oriented. Use it to inspect what the agent is using, not to replace Agent Surface decisions or native ticket work.