Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
B
buvard
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PLN
buvard
Commits
318c8c16
Commit
318c8c16
authored
Nov 07, 2026
by
PLN (Algolia)
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: README agents section — the three usage paths
parent
4556ff36
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
0 deletions
+15
-0
README.md
README.md
+15
-0
No files found.
README.md
View file @
318c8c16
...
@@ -41,6 +41,21 @@ stay manual checks. docs/research.md holds the clustering study;
...
@@ -41,6 +41,21 @@ stay manual checks. docs/research.md holds the clustering study;
docs/research-litreview.md (in progress) holds the literature review and
docs/research-litreview.md (in progress) holds the literature review and
the falsifiable recommendations that will become catalog v3.
the falsifiable recommendations that will become catalog v3.
## Agents
Agents run buvard three ways, in order of friction:
```
bash
npx buvard check
.
# after npm publish — no install at all
node bin/buvard.js check
.
# from a clone — zero dependencies, Node >= 18
buvard check
.
# global symlink (see install above)
```
`AGENTS.md`
carries the project handoff for any agent;
`SKILL.md`
packages the
catalog as an agent skill: load it, run the linter, apply the findings by hand.
Hits are review candidates, never verdicts — the agent edits prose like an
editor, not like a filter.
## Skill
## Skill
`SKILL.md`
ships the catalog as an agent skill: load it, run the linter,
`SKILL.md`
ships the catalog as an agent skill: load it, run the linter,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment