general: T8595: add CLAUDE.md

[andamasov]

Summary

Adds a single source of truth for repo-level agent instructions, plus three symlinks so different agentic tools all read the same content from one canonical file.

Files added:

Path	Type	Consumed by
CLAUDE.md	real file	Claude Code, Anthropic agents
AGENTS.md	symlink → CLAUDE.md	tools that follow the AGENTS.md convention (e.g. OpenAI Codex)
.cursorrules	symlink → CLAUDE.md	Cursor
.github/copilot-instructions.md	symlink → ../CLAUDE.md	GitHub Copilot (docs)

Rationale

• One source of truth — guidance lives in CLAUDE.md, the symlinks are zero-content. No drift between four files.
• Each agentic tool reads its canonical filename and gets the same content.
• Mac/Linux dev environments handle symlinks natively. Windows checkouts may render them as text files containing the target path; the canonical CLAUDE.md is unaffected and still rendered/served correctly by GitHub.

Out of scope

Path-specific Copilot instructions (.github/instructions/*.instructions.md) need YAML frontmatter (applyTo:) and target specific globs, so they cannot be symlinks. Not added here; they can be authored as separate small files per-repo if/when narrow path-scoped guidance is needed.

Tracked under T8595.

Test plan

• CLAUDE.md renders on GitHub.
• AGENTS.md, .cursorrules, .github/copilot-instructions.md resolve to CLAUDE.md content (readlink returns the right target).
• CI passes.

🤖 Generated by robots

[coderabbitai]

Warning

Rate limit exceeded

@andamasov has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 30 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a409bb10-cbed-4f1a-9bbc-5ff4a59f58be

📥 Commits

Reviewing files that changed from the base of the PR and between 2410a3d and 8219628.

📒 Files selected for processing (3)

• .github/copilot-instructions.md
• AGENTS.md
• CLAUDE.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch T8595-add-claude-md

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch T8595-add-claude-md

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[andamasov]

@copilot review

[Copilot]

@copilot review

Code Review — CLAUDE.md

Overall the content is accurate and useful. A few observations:

Minor issues

1. Redundant heading: # CLAUDE.md as the document title is self-referential since the filename is already CLAUDE.md. A more descriptive title (e.g. # vyos-http-api-tools — AI coding context) would be clearer.

2. Internal Confluence link (line 48): https://internal.confluence.vyos.com/wiki/spaces/VYOS/pages/818282936 is inaccessible to external contributors. If this is intentional (internal-only audience), it's fine; otherwise it should be removed or replaced with a public URL.

3. pip-compile redirect (line 15): pip-compile requirements.in > requirements.txt — the > redirect is unnecessary because pip-compile already writes to requirements.txt by default when given requirements.in. This matches the wording in README.md, so it's consistent, but a note like # output is requirements.txt by default or simply dropping the redirect would be cleaner.

Content accuracy ✅

• Build-depends match debian/control exactly.
• Bundled library list matches requirements.in (FastAPI, uvicorn, ariadne, makefun, sgqlc, pyjwt, python-pam, python-multipart, wsproto).
• Cross-repo references (vyos-1x, vyos-build) are correct.
• Conventions section accurately reflects workflow file names visible in .github/.

No security concerns, no functional issues. The document is safe to merge as-is; the items above are purely polish.

[andamasov]

@copilot review

[Copilot]

@copilot review

Addressed the two remaining polish items from the earlier review in ca3918a:

1. Replaced the self-referential # CLAUDE.md heading with # vyos-http-api-tools — AI coding context.
2. Removed the redundant > requirements.txt redirect from the pip-compile command and added an inline comment clarifying it writes requirements.txt by default.

All three items from the first review are now resolved (Confluence link was already dropped in c2b696e).

[andamasov]

@copilot review

[andamasov]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[andamasov]

Closing in favor of vyos/vyos-http-api-tools#40 under T8595.

Schema changed: AGENTS.md is now the tool-neutral primary instructions file. .github/copilot-instructions.md is a symlink to ../AGENTS.md (verified working with Copilot code review). No CLAUDE.md, no .cursorrules — both tools fall back to AGENTS.md natively.