https://github.com/networktocode/ntc-templates
TextFSM templates for parsing show commands of network devices
https://github.com/networktocode/ntc-templates
Last synced: 7 months ago
JSON representation
TextFSM templates for parsing show commands of network devices
- Host: GitHub
- URL: https://github.com/networktocode/ntc-templates
- Owner: networktocode
- License: other
- Created: 2016-04-27T15:49:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-05-08T21:15:03.000Z (7 months ago)
- Last Synced: 2025-05-08T22:23:57.750Z (7 months ago)
- Language: Python
- Homepage: https://ntc-templates.readthedocs.io/
- Size: 6.39 MB
- Stars: 1,163
- Watchers: 72
- Forks: 758
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: changes_for_4.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-networking - ntc-templates - TextFSM templates for parsing show commands of network devices. (Network Automation / SD-WAN)
README
# NTC Templates
## Overview
Repository of TextFSM Templates for Network Devices, and Python wrapper for TextFSM's CliTable. TextFSM is a tool to help make parsing cli commands more manageable.
## Documentation
Full web-based HTML documentation for this library can be found over on the [NTC Templates Docs](https://ntc-templates.readthedocs.io) website:
- [User Guide](https://ntc-templates.readthedocs.io/en/latest/user/lib_overview/) - Overview, Using the library, Getting Started.
- [Administrator Guide](https://ntc-templates.readthedocs.io/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the library.
- [Developer Guide](https://ntc-templates.readthedocs.io/en/latest/dev/contributing/) - Extending the library, Code Reference, Contribution Guide.
- [Release Notes / Changelog](https://ntc-templates.readthedocs.io/en/latest/admin/release_notes/).
- [Frequently Asked Questions](https://ntc-templates.readthedocs.io/en/latest/user/faq/).
### Contributing to the Docs
All the Markdown source for the library documentation can be found under the [docs](https://github.com/networktocode/ntc-templates/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.
If you need to view the fully generated documentation site, you can build it with [mkdocs](https://www.mkdocs.org/). A container hosting the docs will be started using the invoke commands (details in the [Development Environment Guide](https://ntc-templates.readthedocs.io/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). As your changes are saved, the live docs will be automatically reloaded.
Any PRs with fixes or improvements are very welcome!
## Questions
For any questions or comments, please check the [FAQ](https://ntc-templates.readthedocs.io/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#networktocode`), sign up [here](http://slack.networktocode.com/) if you don't have an account.
## Additional Automation Resources
There are situations where one solution or tool might not fulfill needs or as well as another. Fortunately there are often alternatives and the [Awesome Network Automation](https://github.com/networktocode/awesome-network-automation) list can help introduce you to additional resources and solutions!