vkr-development

A set of coding rules for the vkr-builder project, including where code belongs, how messages are written, and how tests and document output work.

In plain words
What is it for?
Use it when modifying vkr-builder modules, adding warnings, changing document generation, adjusting terminal alignment, or writing tests.
Why use it?
It keeps changes consistent across the project and prevents user messages, warning rules, formatting, and file locations from drifting apart.

Cursor rule for Cursor

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.

agentmods
npx agentmods add rules/maxbarsukov/vkr-builder/vkr-development
Clone the repo
git clone --depth 1 https://github.com/maxbarsukov/vkr-builder

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 615 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00000 $0.00615
Opus 5 $0.00000 $0.00308
Sonnet 5 $0.00000 $0.00123
Haiku 4.5 $0.00000 $0.00061

Measured 2d ago against content hash 20e1030adc5c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

vkr-development 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 2d 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/vkr-development.mdc · 62 lines

How it starts

The opening of the file, as written. The whole thing — 62 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Changing the code

src/vkr/cli.py            commands: parse, orchestrate, render the report
src/vkr/ui.py             the only module that writes to the user
src/vkr/progress.py       build phases as console steps
src/vkr/logging_setup.py  logging -> findings bridge
src/vkr/suppress.py       rule names and @suppress directives
src/vkr/engines.py        Word / LibreOffice detection, "auto"
src/vkr/md.py, md_lint.py markdown parsing and checks
src/vkr/docx/             document building
src/vkr/pagination.py     Word COM and LibreOffice UNO
src/tests/                pytest

Output

  • Only ui.py writes to a stream. Library modules call log.warning(...); logging_setup turns records into findings. No print(), no direct sys.stderr outside ui.py.

  • Give user-facing warnings a rule so they can be suppressed and looked up:

    log.warning("could not insert image %s: %s", path, exc,
                extra={"rule": "image"})
    

    and document that name in suppress.RULES — a test fails on rules that are used but undocumented.

  • Message style: lower-case opening, no trailing period, no module prefix.

  • Alignment uses terminal columns: ui.text_width / ui._pad, never len() or ljust(). Any emoji is two columns wide and breaks every column after it; the status glyphs are guarded by a test.

  • Body text keeps the terminal's default colour so the report works on light and dark themes; colour is for status glyphs, the title and paths.

Commands

Every command renders header → steps/findings → exactly one footer (footer_ok/footer_warn/footer_fail). Resolve the engine once via _engine(cfg, args). Argparse never prints its own usage — -h and CLI errors go through this module's renderer.

Tests

python -m pytest src/tests. UI behaviour is tested by rendering into a StringIO console (fake TTY for the live region); assert on columns and shapes, not on colour codes. A change to the report is not finished until the samples in ui.py's docstring and in both READMEs match reality.

Read the full file on GitHub · 62 lines

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. 2d ago First seen · 62 lines · 0 tokens per session scan A 20e1030adc5c

Subscribe to this mod's changes

vkr-development is a cursor rule published in the GitHub repository maxbarsukov/vkr-builder (4 stars, last pushed 21d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 615 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-08-31.