# README
Automated WireGuard® Management Client
This is the client for Netmaker networks. To learn more about Netmaker, see here.
Installation
https://docs.netmaker.org/netclient.html#installation
Usage
https://docs.netmaker.org/netclient.html#joining-a-network
Join a network
With Token:
netclient join -t <token>
With User (Basic Auth):
netclient join -n <net name> -u <username> -s api.<netmaker domain>
With User (SSO):
netclient join -n <net name> -s api.<netmaker domain>
Commands
Netmaker's netclient agent and CLI to manage wireguard networks
Join, leave, connect and disconnect from netmaker wireguard networks.
Usage:
netclient [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
connect connect to a netmaker network
daemon netclient daemon
disconnect disconnet from a network
help Help about any command
install install netclient binary and daemon
join join a network
leave leave a network
list display list of netmaker networks
pull get the latest node configuration
uninstall uninstall netclient
version Displays version information
Flags:
--config string use specified config file
-h, --help help for netclient
-v, --verbosity int set logging verbosity 0-4
Use "netclient [command] --help" for more information about a command.
Disclaimer
WireGuard is a registered trademark of Jason A. Donenfeld.
License
Netclient's source code and all artifacts in this repository are freely available under the Apache 2.0 License, which can be found here: LICENSE.txt.
# Packages
Package auth provides netclient auth logic with server.
No description provided by the author
Copyright © 2022 Netmaker Team <[email protected]>
*/.
Package config provides functions for reading the config.
Package daemon provide functions to control execution of deamons.
No description provided by the author
No description provided by the author
Package local provide functions for setting routes.
No description provided by the author
Package ncutils contains utility functions.
No description provided by the author
No description provided by the author
Package wireguard manipulates wireguard interfaces.