GettingStarted

Getting Started

How to configure development environment

Setting up development environment is easy given that the only runtime dependancy for configctl is libyang. It is required to install libyang v0.3.4 either from source, or use packages available for your distribution. To name a few here are the pointers for OpenWrt and Arch distributions.

Once libyang has been installed you can move on to configctl installation and setup. First clone the configctl repository:

git clone https://github.com/sysrepo/configctl.git
cd configctl/build

Then in order to prepare configctl with default configuration run the following:

cmake ..

In case you want to use the Swig bindings make sure to enable correct flags such as these:

# for Java
cmake .. -DJAVA_BINDING=ON
# for Python 2
cmake .. -DPYTHON_BINDING="2"
# for Python 3
cmake .. -DPYTHON_BINDING="3"

After cmake configuration it is enough to run make:

make

You can run the tests with ctest command:

ctest

To start using the configctl API take a look at the confictl header file. You will also find handy the youtube sysrepo channel with configctl examples.