Gitiles
Code Review Sign In
gerrit.cesnet.cz / CzechLight / netconf-cli / 81ecbeb27508b4b01ba18f6f34a1b8b1e06a00ad
commit81ecbeb27508b4b01ba18f6f34a1b8b1e06a00ad[log] [tgz]
authorJan Kundrát <jan.kundrat@cesnet.cz>Fri Oct 22 13:41:46 2021 +0200
committerJan Kundrát <jan.kundrat@cesnet.cz>Fri Oct 22 13:51:15 2021 +0200
treee6af38a640afb4f11667d2ab7f259addfd48d26e
parent6fbd0869b535fe64ff1e3644aac51e13eec86db6 [diff]
doc: better description of dependencies

Explain that this branch requires the `libyangv1` branches of
everything, and clarify where one can get the `dependencies` repo. This
part is not really smooth because of that annoying difference in repo
naming between GitHub and our Gerrit instance.

Also sync some versions to match with what we're testing against (C++20
and a newer Boost).

Change-Id: Ic51f3ae2b611a746942fa52c89f01757eb5fd108
Reported-by: Petr Gotthard
1 file changed
tree: e6af38a640afb4f11667d2ab7f259addfd48d26e
  1. .clang-format
  2. .gitmodules
  3. .zuul.CzechLight-internal.yaml
  4. .zuul.public.yaml
  5. CMakeLists.txt
  6. Doxyfile.in
  7. LICENSE
  8. LICENSE.md
  9. README.md
  10. ci/
  11. cmake/
  12. docs/
  13. src/
  14. submodules/
  15. tests/
README.md

Console interface to NETCONF servers

This program provides an interactive console for working with YANG data. It can connect to NETCONF servers, and also 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 1.0.x built with C++ support (-DGEN_LANGUAGE_BINDINGS=ON) for working with YANG models
  • libnetconf2 version 1.1.x 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 1.4.x for the local sysrepo backend, and for the comprehensive test suite
  • optionally, netopeer2 version 1.1.x for a test suite

Use an exact commit of any dependencies as specified in submodules/dependencies/*.

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). 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.