| commit | 6ee8cf1a29f53ebe96fdc33d270e00d601b3657f | [log] [tgz] |
|---|---|---|
| author | Jan Kundrát <jan.kundrat@cesnet.cz> | Fri Dec 02 12:09:09 2022 +0100 |
| committer | Jan Kundrát <jan.kundrat@cesnet.cz> | Fri Dec 02 12:09:09 2022 +0100 |
| tree | 3bd69e84893eb40d6df3624e9716fdd0ff83ad42 | |
| parent | 0a2503000cd5ae27c72229aaa50da781841abc4f [diff] |
docs: clarify that this is a standalone YANG editor, too Change-Id: Ie5c8a9ca1238f80d09aaa76a901696d52c724b9f
Console interface to NETCONF servers
This program provides an interactive console for working with YANG data. It can connect to NETCONF servers, work as a standalone YANG data editor, or talk to sysrepo locally.
Installation
For building, one needs:
- A C++20 compiler
- Boost (we're testing with
1.75) - cmake for managing the build
- libyang version 2.0 plus the C++ bindings
- libnetconf2 version 2.1 plus the C++ bindings for connecting to NETCONF servers
- replxx which provides interactive line prompts
- docopt for CLI option parsing
- pkg-config for building
- optionally, Doctest as a C++ unit test framework
- optionally, trompeloeil for mock objects in C++
- optionally, sysrepo version 2.1 plus the C++ bindings for the local sysrepo backend, and for the comprehensive test suite
- optionally, netopeer2 version 2.1 for a test suite
The build process uses CMake. A quick-and-dirty build with no fancy options can be as simple as mkdir build && cd build && cmake .. && make && make install.
Bug Reporting
Issue reporting and feature requests are welcome via Taiga.io.
Development
We are using Gerrit for patch submission, code review and Continuous Integration (CI). A quick introduction is recommended for first-time Gerrit users. Choose CESNET - Sign in with GitHub for login. Development roadmap and planning happens over Taiga.io.
Credits
Copyright © CESNET, https://www.cesnet.cz/ . Portions copyright © Faculty of Information Technology, Czech Technical University in Prague, https://fit.cvut.cz/ . Most of the code was written by Václav Kubernát (CESNET, formerly FIT ČVUT) and Jan Kundrát (CESNET). The project is distributed under the terms of the Apache 2.0 license.