labctlGetting Started
Installation
Labctl is distributed as a single executable for Linux based distros
bash
bash -c "$(curl -sL https://labctl.net/get.sh)"Run a console command
labctl includes console commands, al list of these commands can be seen when you run the command without parameters, or using the --help flag with any of the sub-commands. The command reference includes details on each command
labctl --help
bash
Usage: labctl <command>
Control your network lab.
Flags:
-h, --help Show context-sensitive help.
Global Flags
-d, --debug=INT Enable debug mode.
--settings=STRING Settings yaml file.
Commands:
color Add some color to any Linux command (i.e. ssh).
config commit Commit configuration on the node.
config compare Compare rendered templates to the node's config.
config send Send commands to the node (i.e. show)
config template Show rendered templates.
config vars Show variable inputs.
serve Serve the web UI.
install-completions install shell completions
version show the labctl version
Run "labctl <command> --help" for more information on a command.Start the web server
The Config Engine UI can be started with the labctl serve command.
Once the server is started you should be able to open the suggested URLs with your browser
$ labctl serve -t topo.clab.yaml -p ./ --addr :8080
INFO[0000] Parsing & checking topology file: topo.clab.yaml
INFO[0000] Access the web server on http://localhost:8080 or http://10.10.56.51:8080The labctl serve reference contains detail on available flags for the web server.