torben/chemenu
1
1 Fork 0
Code Issues 40 Pull Requests Actions Packages Releases 41 Wiki Activity
Page: How to Export guidelines
Pages
Dev Development Explanation Architecture Explanation Configuration tiers Explanation Knowledge and commitment Explanation Language boundaries Explanation Model and effort selection Explanation Ownership and templates Explanation Pipeline rationale Explanation Telemetry and evaluation Explanation Version model Explanation Why gates are code Explanation Home How to Back up to a synced folder How to Browse with obsidian How to Capture repository docs How to Collect from a synced folder How to Export guidelines How to Export to a synced folder How to Fetch pages behind a login How to Ingest a source How to Maintain the wiki How to Query the wiki How to Run the weekly review How to Set up the mcp server How to Trace and score sessions How to Troubleshoot How to Update an instance How to Use 1password for settings How to Write a site handler How to Install Reference Commands Catalog and log Reference Commands Configuration Reference Commands Content migrations Reference Commands Distribution and versioning Reference Commands Exports Reference Commands Finding and checking Reference Commands Git Reference Commands Instance health Reference Commands Links and citations Reference Commands Pages Reference Commands Provenance Reference Commands Raw material and uploads Reference Commands Telemetry Reference Commands Types instructions and docs Reference Commands Workshop runs and session budget Reference Commands Reference Configuration Reference Exit codes Reference Page types Reference Skills Reference Tutorials First source to first answer Tutorials Sample source Tutorials
Clone
3
How to Export guidelines
Wiki Mirror edited this page 2026-10-16 14:43:37 +00:00
Unescape Escape
Table of Contents
This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Generated from docs/how-to/export-guidelines.md at v10.1.0 – edit the repository, not this wiki.

Export guidelines to captured repositories

The repositories the wiki captures documentation from can get something back: the wiki's guidelines, as one generated GUIDELINES.md in each repository's root, which that repository's own agents then read.

What you prepare

  • Decide which pages count as guidelines. That decision is yours, and it is written down in kb/CONVENTIONS.md § Guidelines for other repositories. Usually it is a tag. To see the file exactly as it would be written, without touching any repository:

    tools/wikitool export guidelines --tag guideline

  • Opt each repository in, by hand, once. A repository takes part only if it carries a GUIDELINES.md whose first line is exactly:

    <!-- wikitool:export kind=guidelines -->

    Commit that one line there. Then point the repository's own AGENTS.md at the file (for Claude Code: @GUIDELINES.md). A GUIDELINES.md without that first line is hand-written, and the export never touches it.

The repository has to be one the wiki has captured (Capture documentation from a git repository). That is how the export knows where the repository lives. Its capture also has to follow a branch: a repository captured by a tag pattern is skipped, because a tag has no branch to commit onto.

What you say

Roll out the guidelines to the captured repositories

Where the agent stops

The agent runs export guidelines --push, which stops before pushing anything. This is the Guideline Push Gate (exit 42). For every repository, it prints the status, the diff it would write and a --confirm <token> line. The agent puts every diff in front of you. Only your approval pushes, and then only one commit per repository, which changes only GUIDELINES.md and goes straight onto its branch.

The token is a digest of each target's branch tip and of the generated file. If a branch has moved or a guideline was edited since you looked, the gate asks again rather than pushing something you did not see.

Related