Skip to content

docs: add CLAUDE.md, AGENTS.md symlink and refresh README help - #26

Merged
AcidSailor merged 2 commits into
mainfrom
docs/claude-md
Aug 24, 2026
Merged

docs: add CLAUDE.md, AGENTS.md symlink and refresh README help#26
AcidSailor merged 2 commits into
mainfrom
docs/claude-md

Conversation

@AcidSailor

@AcidSailor AcidSailor commented Aug 24, 2026

Copy link
Copy Markdown
Owner

Adds a repository-level CLAUDE.md, the AGENTS.md symlink pointing at it,
and refreshes the stale --help block in README.md.

ncli was one of three repositories with no CLAUDE.md, which is why it had
no AGENTS.md symlink to add in #25.

README

The pasted --help output predated --with-nc-version and omitted it. It is
regenerated from go run . --help and now matches byte-for-byte — note cobra
realigns every column, since --with-nc-version is the longest flag name.

CLAUDE.md

Content is derived from the code, not from sibling repositories: the command
table comes from this repo's own taskfile.yml, and the documented flags,
defaults, and control flow were each checked against cmd/.

Notable gotchas captured:

  • Host key checking is hardcoded off (WithAuthNoStrictKey).
  • Transport is pinned to standard, which is what allows CGO_ENABLED=0 and
    the FROM scratch image.
  • hello bypasses d.Open() and ignores --lock.
  • --filter-type values other than subtree/xpath fall through unvalidated.
  • Two distinct error channels: transport err versus NETCONF r.Failed.

🤖 Assisted with Codex and Claude 🤖

The pasted output predated the flag. Regenerated from 'go run . --help',
which also realigns every column now that --with-nc-version is the
longest flag name.
@AcidSailor AcidSailor changed the title docs: add CLAUDE.md and AGENTS.md symlink docs: add CLAUDE.md, AGENTS.md symlink and refresh README help Aug 24, 2026
@AcidSailor
AcidSailor marked this pull request as ready for review August 24, 2026 18:36
@AcidSailor
AcidSailor merged commit 1f60d35 into main Aug 24, 2026
2 checks passed
@AcidSailor
AcidSailor deleted the docs/claude-md branch August 24, 2026 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant