docs

docs is a cursor rule for Cursor from extsoft/elegant-git. It costs 0 tokens per session (520 once invoked), scanned A, original, MIT.

A writing guide for Elegant Git's user documentation site. It defines page names, navigation, headings, front matter, links, and how command documentation should be structured.

In plain words
What is it for?
It is for writing command guides, object overviews, action pages, cross-links, and documentation metadata.
Why use it?
It keeps documentation pages consistent and makes the site's navigation and formatting work correctly.

Cursor rule for Cursor

Written for Cursor: installed under .cursor/.

Good fit It is for writing command guides, object overviews, action pages, cross-links, and…

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/extsoft/elegant-git/docs
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo
git clone --depth 1 https://github.com/extsoft/elegant-git

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docs

README.md
[![agentmods](https://agentmods.dev/badge/rules/extsoft/elegant-git/docs.svg)](https://agentmods.dev/rules/extsoft/elegant-git/docs)
Your own site
<a href="https://agentmods.dev/rules/extsoft/elegant-git/docs"><img src="https://agentmods.dev/badge/rules/extsoft/elegant-git/docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 520 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00000 $0.00520
Opus 5 $0.00000 $0.00260
Sonnet 5 $0.00000 $0.00104
Haiku 4.5 $0.00000 $0.00052

Measured 3d ago against content hash e5a1c33ea57e, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/docs.mdc · 57 lines

What it actually says

Docs writing

Read .cursor/references/glossary.md before naming. docs/** is excluded from prosefmt (.config/hk.pkl); wrap prose near 100 columns yourself.

Site shape

  • Numbered chapters: NN-title.md; object parents NN-00-<object>.md; actions NN-MM-<object>-<action>.md.
  • Front matter: layout: default; title equals H1; nav_order; pretty permalink. Children set parent: to the parent title exactly. Parents add has_children: true and has_toc: false.
  • Titles: "self" guide (not "eg self" guide); anatomy CLI anatomy; action pages eg self configure.
  • Cross-link with relative .md paths.

Object landing (xx-00)

Short lead, then ## Actions first — unordered list, one-line purposes from commandGroups in internal/cli/commands.go. Then concept. No per-action ## plus fenced bash.

# BAD
title: self
## configure
```bash
eg self configure

See eg self configure.

GOOD

title: '"self" guide'

Actions

  • configure — Configures Git and the Elegant Git installation.

## Action pages

Lead with what the command is for. One short `bash` invocation, explanation after it. `##`
headings are topics (`What it applies`), never `Synopsis` / `Arguments` / `See also`.
Second-person prose; bullets only for real lists; tables stay in `docs/reference/`.
Write from the Go implementation. Skip hidden/deprecated commands.

## Vocabulary

- **Elegant Git installation** — this machine’s `eg` (shared memory, acquired, aliases).
- **Git configuration** — `git config` (identity, standards). Do not say “Git installation” for
  `self`.
- `git elegant` is a feature (git alias after configure), not leftover. Do not lead with the
  `git-elegant` binary or completions unless the page is about upgrading.
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 57 lines · 0 tokens per session scan A e5a1c33ea57e

Subscribe to this mod's changes

docs is a cursor rule published in the GitHub repository extsoft/elegant-git (47 stars, last pushed 4d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 520 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.