diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-10 22:27:44 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-10 22:27:44 +0300 |
| commit | 960d03083ab2eba0c44695e4369737f4777d5833 (patch) | |
| tree | 5c7443f9f073b70b709195e1e6554a447cc8de5a | |
| parent | e6e95c01f4ffe3ae5284a36e460eaeccc42b3486 (diff) | |
| parent | e5105c905e6bb4c0bdc2f4435687437c78fd27ad (diff) | |
| download | vyos-documentation-960d03083ab2eba0c44695e4369737f4777d5833.tar.gz vyos-documentation-960d03083ab2eba0c44695e4369737f4777d5833.zip | |
Merge pull request #1946 from vyos/yuriy/context7-rules-expand
docs: expand context7 rules — VyOS-specific LLM guardrails
| -rw-r--r-- | context7.json | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/context7.json b/context7.json index f2bff61c..804004b2 100644 --- a/context7.json +++ b/context7.json @@ -24,11 +24,16 @@ ], "rules": [ "Documentation sources are MyST Markdown (.md). Cite and link to the .md form.", - "VyOS has two CLI modes: configuration mode (`set ...`, `delete ...`, `commit`, `save`) and operational mode (`show ...`, `monitor ...`, `restart ...`). Do not mix them.", + "VyOS has two CLI modes: configuration mode (entered via `configure`; for `set`/`delete`/`commit`/`save` and config-state `show`) and operational mode (default after login; for `show`, `monitor`, plus image-mgmt like `add system image`). Do not mix.", "Configuration commands are wrapped in `cfgcmd` fenced blocks; operational commands in `opcmd` fenced blocks. Treat these as authoritative command syntax.", "Branch `rolling` tracks the rolling release and the next stable line. Branch `circinus` tracks 1.5.x. Branch `sagitta` tracks 1.4.x. Always cite version-appropriate documentation.", "Do not invent CLI commands. If a command isn't in the docs, say so rather than guess — VyOS syntax is strict and unknown commands fail validation at commit time.", - "Use reserved documentation IP space in examples: 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24 (RFC 5737), 2001:db8::/32 (RFC 3849). Never use real or RFC1918 addresses." + "Use reserved documentation IP space in examples: 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24 (RFC 5737), 2001:db8::/32 (RFC 3849). Never use real or RFC1918 addresses.", + "`commit` activates pending `set`/`delete` changes and runs validation (errors = no change applied); `save` persists across reboot. Verify with `show <node>` (config mode) or `show configuration commands` (op mode). Always include `commit` and `save`.", + "VyOS is image-based, not package-managed. Upgrade in op mode: `add system image <url>`, optionally `set system image default-boot <name>`, then `reboot` to activate. Do not recommend `apt install` for VyOS components — it bypasses the image system.", + "Do not recommend raw Linux commands (`ip`, `iptables`, `systemctl`, NetworkManager) for VyOS configuration — they bypass the CLI and do not persist. Use `set/delete/commit/save`. Read-only Linux inspection from op mode is fine.", + "Quote CLI strings containing spaces or special chars with single quotes (e.g. `set system host-name 'edge-01'`). Top-level `set`/`delete` lines must include the full path; relative paths only work inside an `edit` subtree (e.g. `edit firewall name FOO`).", + "Routing protocols (BGP, OSPF, IS-IS, RIP) are FRR-backed, but not every FRR knob is exposed through the VyOS CLI. Confirm a command exists in the VyOS docs before suggesting it — synthesizing from FRR documentation produces invalid VyOS commands." ], "previousVersions": [ { "tag": "1.5" }, |