Repository navigation
Command line
The engine binary that ships inside the extension is also a command line, for CI jobs and git
hooks. It runs the same method handlers the editors call, so sync plans and writes exactly
what the same sync from the editor would.
lore-master-engine generate [--workspace DIR] [--generator N]... [--json]
lore-master-engine tree [--workspace DIR] [--output N]... [--json]
lore-master-engine sync [--workspace DIR] [--output N]... [--scope PATH]... [--generate]
[--yes] [--dry-run] [--force] [--prune] [--json]
lore-master-engine watch [--workspace DIR] [--output N]... [--yes] [--force]
[--debounce 2s] [--poll 1s]
lore-master-engine pages build --out DIR [--workspace DIR] [--output N] [--json]
lore-master-engine pages publish [--workspace DIR] [--output N] [--json]
lore-master-engine pages check [--workspace DIR] [--output N] [--exit-code] [--json]
lore-master-engine version
-
generateruns the generators of.lore-master.yaml. -
treeshows the page tree each output would sync, with each page's local status. -
syncplans each output. Without--yesit only shows the plan.--generateruns the generators first;--forceoverwrites pages edited on the platform;--prunetrashes pages whose file is gone. -
pages build,pages publishandpages checkalso take agithub-wikioutput; see GitHub wiki. -
pages buildrenders a GitHub Pages output's static site into--outwith no git and no network. The folder is created, replaced when an earlier build wrote it (it carries a.lore-master-sitemarker), and refused when it holds other files, so a build can never wipe a web app that shares the folder. Use it when your pipeline deploys the folder itself (a Pages artifact, an object store); see Docs beside another site.--outputis needed only when the settings have several GitHub Pages outputs. -
pages publishpushes the same site to the output's branch (defaultgh-pages). -
pages checksays whether a publish would change anything, and lists the files it would add, modify or remove, without publishing.--exit-codeexits 2 when the published site is out of date, so a pipeline can fail on stale docs. The VS Code Check remote status button does the same for a GitHub Pages output. -
watchkeeps the storage up to date as files change, regenerating and syncing only what changed. See watch mode.
Outputs and generators are numbered by position in the settings file. --json prints one
document on stdout; progress lines always go to stderr.
From the environment, never from a file:
| Variables | For |
|---|---|
LORE_MASTER_EMAIL + LORE_MASTER_TOKEN
|
Confluence Cloud |
LORE_MASTER_PAT |
Confluence Data Center, Server 7.9+ |
LORE_MASTER_USER + LORE_MASTER_PASSWORD
|
Confluence Server (basic) |
GitHub Pages outputs need none: git carries the credentials.
| Code | Meaning |
|---|---|
| 0 | Done |
| 1 | Failed: bad settings, refused credential, a generator or page failed |
| 2 | Stopped before changing the platform: plan errors, or pages edited on the platform and no --force
|
| 64 | Wrong command line |
Mermaid diagrams stay code blocks (the editor draws them; the command line has no browser), with the usual warning.
# GitHub Actions
- run: lore-master-engine sync --generate --yes
env:
LORE_MASTER_EMAIL: ${{ secrets.CONFLUENCE_EMAIL }}
LORE_MASTER_TOKEN: ${{ secrets.CONFLUENCE_TOKEN }}GitHub Pages serves one site per repository, and a deploy replaces all of it. When the repository already deploys something to Pages (a web app, say), build the docs into a subfolder of that deploy instead of publishing a branch:
# the Actions-source workflow that already builds the app
- run: npm run build # produces dist/
- run: lore-master-engine pages build --out dist/docs
- uses: actions/upload-pages-artifact@v4
with:
path: distThe app stays at / and the docs appear at /docs/. Every link in the site is relative, so it
works under any subpath. upload-pages-artifact leaves dotfiles out, so the marker is not
deployed.
If the repository deploys from a branch instead (for example gh-pages written by another
tool), publish the docs into a folder of that branch with the output's path setting:
outputs:
- platform: github-pages
direction: to-platform
branch: gh-pages
path: docs # only this folder is replaced
content:
- type: markdown
roots: ["."]
template: defaultThe other deploy must keep what it did not write (keep_files: true for
peaceiris/actions-gh-pages). Publishing without path to a branch that holds another site is
refused and the branch is left untouched; a branch an earlier LoreMaster published to is
recognised and replaced as before.
-
LoreMaster documentation
- A documentation agent that follows the LoreMaster structure
- ADR: One Go engine, thin editor shells
- ADR: Vertical feature slices, in Go and TypeScript
- Choosing what goes where
- Command line
- Confluence editions: the facts the design rests on
- Confluence tenant for recorded fixtures
- Generators: pages written from your project's artifacts
- Getting started: syncing a workspace to Confluence
- GitHub Action: the docs site in one step
- Publishing to a GitHub wiki
- The MCP server
- Two-way sync: pull remote edits back, conflict when both sides change
- Using the MCP server
- Watch mode