| commit | 4220593fb00b8629d1c3729a898d1f57d6f21edc | [log] [tgz] |
|---|---|---|
| author | Jan Kundrát <jan.kundrat@cesnet.cz> | Wed Oct 04 21:20:59 2023 +0200 |
| committer | Jan Kundrát <jan.kundrat@cesnet.cz> | Wed Oct 04 21:20:59 2023 +0200 |
| tree | 90bd9c2af3ce03e485dd578913099e28ce0ad5f8 | |
| parent | 8c8183f15e186b0ad9d29159d29e9e71b75e31df [diff] |
docs: clarify what versions of the NETCONF/YANG libraries are required Change-Id: Ic0d75370ea4df682b3e61a13d89f231bd651ef7d
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.78) - cmake for managing the build
- libyang version 2.x plus the C++ bindings
- libnetconf2 version 2.x 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.x plus the C++ bindings for the local sysrepo backend, and for the comprehensive test suite
- optionally, netopeer2 version 2.x for a test suite
At times the devel branch of libyang, sysrepo, libnetconf2 and Netopeer2 might be required due to fresh bugfixes and behavior changes.
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.