Git-versioned inventory for network infrastructure and systems, with YAML schemas, validation, and Snowflake ID generation.
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- Configuration
- Operations
- Commands
- Exit codes
- Support
- Links
- License
NetDoc validates YAML, reports date freshness, and prints topology graphs and Snowflake IDs.
- Node.js 26 or later.
- npm to install the package and run repository checks.
Install the public package:
npm install --global @eliware/netdocThe package includes the netdoc command, source, schemas, and user guide. Only approved releases publish versions to npm.
Run netdoc --help to list commands. Read the CLI guide for command details and the release notes for version history.
Read AGENTS.md, the documentation index, and the specification index before you change files.
Run npm ci to install locked dependencies. Run npm test for repository checks and test coverage.
If a command fails, read its error and correct the named path, option, or YAML value.
Do not add credentials, keys, secrets, or private data to inventory files.
NetDoc has no runtime settings or environment variables.
NetDoc reads inventory and prints results. It does not change files or connect to devices.
| Command | Result |
|---|---|
netdoc --help |
List commands. |
netdoc --version |
Print the package version. |
netdoc validate <path> |
Check YAML files and print text results. |
netdoc validate <path> --format text |
Print validation results as text. |
netdoc validate <path> --format json |
Check YAML files and print JSON results. |
netdoc report <path> --freshness --max-age-days DAYS |
Report object dates and age. |
netdoc graph <path> --format mermaid |
Print inventory topology as Mermaid text. |
netdoc --generate-id [-n COUNT] |
Print one or more Snowflake IDs. |
Read the CLI guide for option defaults, errors, and command details.
| Code | Meaning |
|---|---|
0 |
The command completed. |
1 |
YAML data failed a check. |
2 |
Invalid command or path, or NetDoc cannot load its schemas. |
For help, questions, or to chat with the author and community, visit:
