diff options
| author | Yuriy Andamasov <yuriy@andamasov.com> | 2026-05-07 14:04:48 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-07 12:04:48 +0100 |
| commit | 51f0d05d9adfb99514cb515765786fddc1b6c7d7 (patch) | |
| tree | 0efa05b71a43ef0359b81d1f3e7eac618b44654d | |
| parent | 5bff326ef7a6632e36cc0583371b319c31daa2ec (diff) | |
| download | vyos-utils-misc-51f0d05d9adfb99514cb515765786fddc1b6c7d7.tar.gz vyos-utils-misc-51f0d05d9adfb99514cb515765786fddc1b6c7d7.zip | |
general: T8595: add CLAUDE.md (#4)
* general: T8595: add CLAUDE.md
* general: T8595: drop internal Confluence link footer from CLAUDE.md
* general: T8595: add AGENTS.md and .cursorrules symlinks to CLAUDE.md
* general: T8595: add .github/copilot-instructions.md symlink to CLAUDE.md
* general: T8595: drop .cursorrules symlink
* Update CLAUDE.md
* Update CLAUDE.md
---------
Co-authored-by: Daniil Baturin <daniil@vyos.io>
| l--------- | .github/copilot-instructions.md | 1 | ||||
| l--------- | AGENTS.md | 1 | ||||
| -rw-r--r-- | CLAUDE.md | 36 |
3 files changed, 38 insertions, 0 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 120000 index 0000000..949a29f --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1 @@ +../CLAUDE.md
\ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 120000 index 0000000..681311e --- /dev/null +++ b/AGENTS.md @@ -0,0 +1 @@ +CLAUDE.md
\ No newline at end of file diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..79711fa --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,36 @@ +# CLAUDE.md + +## Project purpose +A grab-bag of community-contributed VyOS helper scripts: admin tools, build tools, config processors, format converters. Not part of the shipped image — these are external scripts maintained loosely. + +## Tech stack +- Mostly Perl (admin-tools: `dhcpremember.pl`, `ovpnbundle.pl`, `ravpnlist.pl`). +- Other subdirectories carry shell / Python / format-conversion helpers. +- No top-level build system; scripts run standalone. + +## Build / test / run +- No build. Each subdirectory's script is self-contained — read each `README` for invocation. +- No automated tests. + +## Repository layout +- `admin-tools/` — Perl operator helpers (DHCP lease tracker, OpenVPN bundle generator, RA-VPN client lister). +- `build-tools/` — image/build helpers. +- `config-processors/` — config-tree post-processing. +- `converters/` — format conversion. +- `README` — top-level pitch ("contributions welcome"). +- `.github/workflows/` — minimal CI inherited via `vyos/.github` reusables. + +## Cross-repo context +This repo is informal/optional and is not part of the canonical 14-repo build set in `VyOS-Networks/vyos-build-packages/repos.toml`. Stale by category-§3.10 in the relations doc. + +## Conventions +- Commit / PR title: `component: T12345: description` (Phorge ID expected). +- Default branch `master` (per audit baseline); pre-dates the `current` rename. Light governance — community-driven contributions. +- No mandatory LICENSE in tree at root; treat each script's header as authoritative. + +## Mirror relationship +Has a `VyOS-Networks/vyos-utils-misc` twin (also Perl, also tagged stale). Canonical side is here. + +## Notes for future contributors +- README is one paragraph; per-subdir `README` files are the real docs. +- Stale by audit baseline; if you adopt one of these scripts into the product, fold it into `vyos-1x` rather than evolving it here. |