Important
Read README.md for project overview.
The list below covers the toolchain, the modules the binary links, and the release builder.
- Go 1.27+ (see
go.mod) umatare5/cisco-ios-xe-wireless-go– sole RESTCONF SDK for Cisco C9800 WNCurfave/cli/v3– command tree, flags and application lifecyclesirupsen/logrus– process logger and theslogbridge the SDK takesolekukonko/tablewriter– borderless table writergoreleaser– cross-platform release builds, configured by.goreleaser.yml
Read from cmd/main.go – each package is named for what it owns.
cmd/– entry point, exiting on whatinternal/clireturnsinternal/cli/– urfave command tree, flag definitions, exit codes, and theversionstring ldflags setsinternal/config/– flag, environment and file resolution in that precedence, and the grammars it parsesinternal/log/– logrus setup and the*slog.Loggerthe SDK takesinternal/wnc/– sole importer of the SDK, with onefetch_*.goper read and one file per action beside itinternal/show/– per-command row building, the concurrent controller fan-out, and the enum display tablesinternal/render/–Column[T], shared by the table and the JSON writer so a column cannot exist in one onlydocs/– reference pages behind the README, indexed bydocs/README.mdexamples/– a working configuration file whosenotefields carry what JSON has no comment syntax forscripts/– helper scripts the pre-commit hooks run
Run make pre-commit-install first.
- Read
Makefilefor every make target and its requirements. - Read
CONTRIBUTING.mdfor the contribution rules.
Follow Effective Go conventions and the software development principles DRY/YAGNI/SRP.
- Keep code simple and readable, avoiding clever tricks that obscure intent.
- Keep every change minimal, in code, tests, comments and documentation.
- Write simple comments that explain the reasoning behind the code, not just what it does.
- A claim in
docs/cites the Go file and line, or the controller reading it came from.
Follow CONTRIBUTING.md.
- Run
make lintandmake test-unitbefore creating a commit. - Take every fixture and sample identity from
docs/testing.md, never a value read off a device.
Follow Conventional Commits (feat:, fix:, chore(deps):, etc.).
- Sign off every commit with
Signed-off-by:(DCO). - Open PRs against
main. Create Draft PR as default.