apps/cunicu
1
0
Fork 0
mirror of https://codeberg.org/cunicu/cunicu.git synced 2025-09-26 21:01:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

remove auto-generated code and docs

Browse Source 
Signed-off-by: Steffen Vogel <post@steffenvogel.de>
This commit is contained in:
Steffen Vogel
2022-10-07 18:56:39 +02:00
parent 65149e4516
commit deab91dd62
61 changed files with 3 additions and 3211 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@@ -2,7 +2,9 @@ build/
completions/
.vscode/
dist/
/cunicu
docs/usage/man/*.1
docs/usage/md/*.md
cunicu
*.log
*.out
*.test

63
docs/usage/man/cunicu-addresses.1
View File

@@ -1,63 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-addresses - Derive IPv4 and IPv6 addresses from a WireGuard X25519 public key
.SH SYNOPSIS
.PP
\fBcunicu addresses [flags]\fP
.SH DESCRIPTION
.PP
cunīcu auto-configuration feature derives and assigns IPv4 and IPv6 addresses based on the public key of the WireGuard interface.
This sub-command accepts a WireGuard public key on the standard input and prints out the calculated IP addresses on the standard output.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for addresses
.PP
\fB-m\fP, \fB--mask\fP[=false]
Print CIDR mask
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH EXAMPLE
.PP
.RS
.nf
$ wg genkey | wg pubkey | cunicu addresses
fc2f:9a4d:777f:7a97:8197:4a5d:1d1b:ed79
10.237.119.127
.fi
.RE
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

91
docs/usage/man/cunicu-completion-bash.1
View File

@@ -1,91 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-completion-bash - Generate the autocompletion script for bash
.SH SYNOPSIS
.PP
\fBcunicu completion bash\fP
.SH DESCRIPTION
.PP
Generate the autocompletion script for the bash shell.
.PP
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
.PP
To load completions in your current shell session:
.PP
.RS
.nf
source <(cunicu completion bash)
.fi
.RE
.PP
To load completions for every new session, execute once:
.SS Linux:
.PP
.RS
.nf
cunicu completion bash > /etc/bash_completion.d/cunicu
.fi
.RE
.SS macOS:
.PP
.RS
.nf
cunicu completion bash > $(brew --prefix)/etc/bash_completion.d/cunicu
.fi
.RE
.PP
You will need to start a new shell for this setup to take effect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for bash
.PP
\fB--no-descriptions\fP[=false]
disable completion descriptions
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-completion(1)\fP

76
docs/usage/man/cunicu-completion-fish.1
View File

@@ -1,76 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-completion-fish - Generate the autocompletion script for fish
.SH SYNOPSIS
.PP
\fBcunicu completion fish [flags]\fP
.SH DESCRIPTION
.PP
Generate the autocompletion script for the fish shell.
.PP
To load completions in your current shell session:
.PP
.RS
.nf
cunicu completion fish | source
.fi
.RE
.PP
To load completions for every new session, execute once:
.PP
.RS
.nf
cunicu completion fish > ~/.config/fish/completions/cunicu.fish
.fi
.RE
.PP
You will need to start a new shell for this setup to take effect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for fish
.PP
\fB--no-descriptions\fP[=false]
disable completion descriptions
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-completion(1)\fP

65
docs/usage/man/cunicu-completion-powershell.1
View File

@@ -1,65 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-completion-powershell - Generate the autocompletion script for powershell
.SH SYNOPSIS
.PP
\fBcunicu completion powershell [flags]\fP
.SH DESCRIPTION
.PP
Generate the autocompletion script for powershell.
.PP
To load completions in your current shell session:
.PP
.RS
.nf
cunicu completion powershell | Out-String | Invoke-Expression
.fi
.RE
.PP
To load completions for every new session, add the output of the above command
to your powershell profile.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for powershell
.PP
\fB--no-descriptions\fP[=false]
disable completion descriptions
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-completion(1)\fP

100
docs/usage/man/cunicu-completion-zsh.1
View File

@@ -1,100 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-completion-zsh - Generate the autocompletion script for zsh
.SH SYNOPSIS
.PP
\fBcunicu completion zsh [flags]\fP
.SH DESCRIPTION
.PP
Generate the autocompletion script for the zsh shell.
.PP
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
.PP
.RS
.nf
echo "autoload -U compinit; compinit" >> ~/.zshrc
.fi
.RE
.PP
To load completions in your current shell session:
.PP
.RS
.nf
source <(cunicu completion zsh); compdef _cunicu cunicu
.fi
.RE
.PP
To load completions for every new session, execute once:
.SS Linux:
.PP
.RS
.nf
cunicu completion zsh > "${fpath[1]}/_cunicu"
.fi
.RE
.SS macOS:
.PP
.RS
.nf
cunicu completion zsh > $(brew --prefix)/share/zsh/site-functions/_cunicu
.fi
.RE
.PP
You will need to start a new shell for this setup to take effect.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for zsh
.PP
\fB--no-descriptions\fP[=false]
disable completion descriptions
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-completion(1)\fP

46
docs/usage/man/cunicu-completion.1
View File

@@ -1,46 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-completion - Generate the autocompletion script for the specified shell
.SH SYNOPSIS
.PP
\fBcunicu completion [flags]\fP
.SH DESCRIPTION
.PP
Generate the autocompletion script for cunicu for the specified shell.
See each sub-command's help for details on how to use the generated script.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for completion
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP, \fBcunicu-completion-bash(1)\fP, \fBcunicu-completion-fish(1)\fP, \fBcunicu-completion-powershell(1)\fP, \fBcunicu-completion-zsh(1)\fP

49
docs/usage/man/cunicu-config-get.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-config-get - Get current value of a configuration setting
.SH SYNOPSIS
.PP
\fBcunicu config get [key] [flags]\fP
.SH DESCRIPTION
.PP
Get current value of a configuration setting
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for get
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-config(1)\fP

49
docs/usage/man/cunicu-config-reload.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-config-reload - Reload the configuration of the cunīcu daemon
.SH SYNOPSIS
.PP
\fBcunicu config reload [flags]\fP
.SH DESCRIPTION
.PP
Reload the configuration of the cunīcu daemon
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for reload
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-config(1)\fP

49
docs/usage/man/cunicu-config-set.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-config-set - Update the value of a configuration setting
.SH SYNOPSIS
.PP
\fBcunicu config set key value [flags]\fP
.SH DESCRIPTION
.PP
Update the value of a configuration setting
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for set
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-config(1)\fP

46
docs/usage/man/cunicu-config.1
View File

@@ -1,46 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-config - Manage configuration of a running cunīcu daemon.
.SH SYNOPSIS
.PP
\fBcunicu config [flags]\fP
.SH DESCRIPTION
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for config
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP, \fBcunicu-config-get(1)\fP, \fBcunicu-config-reload(1)\fP, \fBcunicu-config-set(1)\fP

136
docs/usage/man/cunicu-daemon.1
View File

@@ -1,136 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-daemon - Start the daemon
.SH SYNOPSIS
.PP
\fBcunicu daemon [interface-names...] [flags]\fP
.SH DESCRIPTION
.PP
Start the daemon
.SH OPTIONS
.PP
\fB-b\fP, \fB--backend\fP=[]
One or more \fB\fCURL\fRs to signaling backends
.PP
\fB-x\fP, \fB--community\fP=""
A \fB\fCpassphrase\fR shared with other peers in the same community
.PP
\fB-c\fP, \fB--config\fP=[]
One or more \fB\fCfilename\fRs of configuration files
.PP
\fB-E\fP, \fB--discover-endpoints\fP[=true]
Enable ICE endpoint discovery
.PP
\fB-P\fP, \fB--discover-peers\fP[=true]
Enable peer discovery
.PP
\fB-D\fP, \fB--domain\fP=[]
A DNS \fB\fCdomain\fR name used for DNS auto-configuration
.PP
\fB--ice-candidate-type\fP=[]
Usable \fB\fCcandidate-type\fRs (one of host, srflx, prflx, relay)
.PP
\fB--ice-network-type\fP=[]
Usable \fB\fCnetwork-type\fRs (one of udp4, udp6, tcp4, tcp6)
.PP
\fB-a\fP, \fB--ice-url\fP=[]
One or more \fB\fCURL\fRs of STUN and/or TURN servers
.PP
\fB-p\fP, \fB--password\fP=""
The \fB\fCpassword\fR for STUN/TURN credentials
.PP
\fB-T\fP, \fB--routing-table\fP=254
Kernel routing table to use
.PP
\fB-s\fP, \fB--rpc-socket\fP=""
The \fB\fCpath\fR of the unix socket used by other cunicu commands
.PP
\fB--rpc-wait\fP[=false]
Wait until first client connected to control socket before continuing start
.PP
\fB-C\fP, \fB--sync-config\fP[=true]
Enable synchronization of configuration files
.PP
\fB-H\fP, \fB--sync-hosts\fP[=true]
Enable synchronization of /etc/hosts file
.PP
\fB-R\fP, \fB--sync-routes\fP[=true]
Enable synchronization of AllowedIPs with Kernel routes
.PP
\fB-u\fP, \fB--username\fP=""
The \fB\fCusername\fR for STUN/TURN credentials
.PP
\fB-w\fP, \fB--watch-config\fP[=false]
Watch configuration files for changes and apply changes at runtime.
.PP
\fB-i\fP, \fB--watch-interval\fP=0s
An interval at which we are periodically polling the kernel for updates on WireGuard interfaces
.PP
\fB-U\fP, \fB--wg-userspace\fP[=false]
Use user-space WireGuard implementation for newly created interfaces
.PP
\fB-h\fP, \fB--help\fP[=false]
help for daemon
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH EXAMPLE
.PP
.RS
.nf
$ cunicu daemon -u -x mysecretpass wg0
.fi
.RE
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

57
docs/usage/man/cunicu-invite.1
View File

@@ -1,57 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-invite - Add a new peer to the local daemon configuration and return the required configuration for this new peer
.SH SYNOPSIS
.PP
\fBcunicu invite [interface] [flags]\fP
.SH DESCRIPTION
.PP
Add a new peer to the local daemon configuration and return the required configuration for this new peer
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for invite
.PP
\fB-L\fP, \fB--listen-port\fP=51820
Listen port for generated config
.PP
\fB-Q\fP, \fB--qr-code\fP[=false]
Show config as QR code in terminal
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

53
docs/usage/man/cunicu-monitor.1
View File

@@ -1,53 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-monitor - Monitor the cunīcu daemon for events
.SH SYNOPSIS
.PP
\fBcunicu monitor [flags]\fP
.SH DESCRIPTION
.PP
Monitor the cunīcu daemon for events
.SH OPTIONS
.PP
\fB-f\fP, \fB--format\fP="human"
Output \fB\fCformat\fR (one of: json, logger, human)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for monitor
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

102
docs/usage/man/cunicu-relay.1
View File

@@ -1,102 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-relay - Start relay API server
.SH SYNOPSIS
.PP
\fBcunicu relay URL... [flags]\fP
.SH DESCRIPTION
.PP
This command starts a gRPC server providing cunicu agents with a list of available STUN and TURN servers.
.PP
\fBNote:\fP Currently this command does not run a TURN server itself. But relies on an external server like Coturn.
.PP
With this feature you can distribute a list of available STUN/TURN servers easily to a fleet of agents.
It also allows to issue short-lived HMAC-SHA1 credentials based the proposed TURN REST API and thereby static long term credentials.
.PP
The command expects a list of STUN or TURN URLs according to RFC7065/RFC7064 with a few extensions:
.RS
.IP \(bu 2
A secret for the TURN REST API can be provided by the 'secret' query parameter
.RS
.IP \(bu 2
Example: turn:server.com?secret=rest-api-secret
.RE
.IP \(bu 2
A time-to-live to the TURN REST API secrets can be provided by the 'ttl' query parameter
.RS
.IP \(bu 2
Example: turn:server.com?ttl=1h
.RE
.IP \(bu 2
Static TURN credentials can be provided by the URIs user info
.RS
.IP \(bu 2
Example: turn:user1:pass1@server.com
.RE
.RE
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for relay
.PP
\fB-L\fP, \fB--listen\fP=":8080"
listen address
.PP
\fB-S\fP, \fB--secure\fP[=false]
listen with TLS
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH EXAMPLE
.PP
.RS
.nf
relay turn:server.com?secret=rest-api-secret&ttl=1h
.fi
.RE
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

49
docs/usage/man/cunicu-reload.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Sep 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-reload - Reload the configuration of the cunīcu daemon
.SH SYNOPSIS
.PP
\fBcunicu reload [flags]\fP
.SH DESCRIPTION
.PP
Reload the configuration of the cunīcu daemon
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for reload
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-C\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

49
docs/usage/man/cunicu-restart.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-restart - Restart the cunīcu daemon
.SH SYNOPSIS
.PP
\fBcunicu restart [flags]\fP
.SH DESCRIPTION
.PP
Restart the cunīcu daemon
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for restart
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

52
docs/usage/man/cunicu-self-update.1
View File

@@ -1,52 +0,0 @@
.nh
.TH "cunīcu" "1" "Sep 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-self-update - Update the cunīcu binary
.SH SYNOPSIS
.PP
\fBcunicu self-update [flags]\fP
.SH DESCRIPTION
.PP
The command "self-update" downloads the latest stable release of cunicu from
GitHub and replaces the currently running binary. After download, the
authenticity of the binary is verified using the GPG signature on the release
files.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for self-update
.PP
\fB-o\fP, \fB--output\fP="cunicu"
Save the downloaded file as \fB\fCfilename\fR
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-C\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

50
docs/usage/man/cunicu-selfupdate.1
View File

@@ -1,50 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-selfupdate - Update the cunīcu binary
.SH SYNOPSIS
.PP
\fBcunicu selfupdate [flags]\fP
.SH DESCRIPTION
.PP
Downloads the latest stable release of cunīcu from GitHub and replaces the currently running binary.
After download, the authenticity of the binary is verified using the GPG signature on the release files.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for selfupdate
.PP
\fB-o\fP, \fB--output\fP="cunicu"
Save the downloaded file as \fB\fCfilename\fR
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

53
docs/usage/man/cunicu-signal.1
View File

@@ -1,53 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-signal - Start gRPC signaling server
.SH SYNOPSIS
.PP
\fBcunicu signal [flags]\fP
.SH DESCRIPTION
.PP
Start gRPC signaling server
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for signal
.PP
\fB-L\fP, \fB--listen\fP=":8080"
listen address
.PP
\fB-S\fP, \fB--secure\fP[=false]
listen with TLS
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

57
docs/usage/man/cunicu-status.1
View File

@@ -1,57 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-status - Show current status of the cunīcu daemon, its interfaces and peers
.SH SYNOPSIS
.PP
\fBcunicu status [interface-name [peer-public-key]] [flags]\fP
.SH DESCRIPTION
.PP
Show current status of the cunīcu daemon, its interfaces and peers
.SH OPTIONS
.PP
\fB-f\fP, \fB--format\fP="human"
Output \fB\fCformat\fR (one of: human, json)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for status
.PP
\fB-i\fP, \fB--indent\fP[=true]
Format and indent JSON ouput
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

49
docs/usage/man/cunicu-stop.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-stop - Shutdown the cunīcu daemon
.SH SYNOPSIS
.PP
\fBcunicu stop [flags]\fP
.SH DESCRIPTION
.PP
Shutdown the cunīcu daemon
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for stop
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

49
docs/usage/man/cunicu-sync.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-sync - Synchronize cunīcu daemon state
.SH SYNOPSIS
.PP
\fBcunicu sync [flags]\fP
.SH DESCRIPTION
.PP
Synchronizes the internal daemon state with kernel routes, interfaces and addresses
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for sync
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

66
docs/usage/man/cunicu-version.1
View File

@@ -1,66 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-version - Show version of the cunīcu binary and optionally also a running daemon
.SH SYNOPSIS
.PP
\fBcunicu version [flags]\fP
.SH DESCRIPTION
.PP
Show version of the cunīcu binary and optionally also a running daemon
.SH OPTIONS
.PP
\fB-f\fP, \fB--format\fP="human"
Output \fB\fCformat\fR (one of: human, json)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for version
.PP
\fB-s\fP, \fB--short\fP[=false]
Only show version and nothing else
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH EXAMPLE
.PP
.RS
.nf
$ sudo cunicu version
client: v0.1.2 (os=linux, arch=arm64, commit=b22ee3e7, branch=master, built-at=2022-09-09T13:44:22+02:00, built-by=goreleaser)
daemon: v0.1.2 (os=linux, arch=arm64, commit=b22ee3e7, branch=master, built-at=2022-09-09T13:44:22+02:00, built-by=goreleaser)
.fi
.RE
.SH SEE ALSO
.PP
\fBcunicu(1)\fP

45
docs/usage/man/cunicu-wg-genkey.1
View File

@@ -1,45 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-wg-genkey - Generates a random private key in base64 and prints it to standard output.
.SH SYNOPSIS
.PP
\fBcunicu wg genkey [flags]\fP
.SH DESCRIPTION
.PP
Generates a random private key in base64 and prints it to standard output.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for genkey
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-wg(1)\fP

45
docs/usage/man/cunicu-wg-genpsk.1
View File

@@ -1,45 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-wg-genpsk - Generates a random preshared key in base64 and prints it to standard output.
.SH SYNOPSIS
.PP
\fBcunicu wg genpsk [flags]\fP
.SH DESCRIPTION
.PP
Generates a random preshared key in base64 and prints it to standard output.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for genpsk
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-wg(1)\fP

58
docs/usage/man/cunicu-wg-pubkey.1
View File

@@ -1,58 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-wg-pubkey - Calculates a public key and prints it in base64 to standard output.
.SH SYNOPSIS
.PP
\fBcunicu wg pubkey [flags]\fP
.SH DESCRIPTION
.PP
Calculates a public key and prints it in base64 to standard output from a corresponding private key (generated with genkey) given in base64 on standard input.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for pubkey
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH EXAMPLE
.PP
.RS
.nf
# A private key and a corresponding public key may be generated at once by calling:
$ umask 077
$ wg genkey | tee private.key | wg pubkey > public.key
.fi
.RE
.SH SEE ALSO
.PP
\fBcunicu-wg(1)\fP

66
docs/usage/man/cunicu-wg-show.1
View File

@@ -1,66 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-wg-show - Shows current WireGuard configuration and runtime information of specified [interface].
.SH SYNOPSIS
.PP
\fBcunicu wg show { interface-name | all | interfaces } [{ public-key | private-key | listen-port | fwmark | peers | preshared-keys | endpoints | allowed-ips | latest-handshakes | transfer | persistent-keepalive | dump }] [flags]\fP
.SH DESCRIPTION
.PP
Shows current WireGuard configuration and runtime information of specified [interface].
.PP
If no [interface] is specified, [interface] defaults to 'all'.
.PP
If 'interfaces' is specified, prints a list of all WireGuard interfaces, one per line, and quits.
.PP
If no options are given after the interface specification, then prints a list of all attributes in a visually pleasing way meant for the terminal.
Otherwise, prints specified information grouped by newlines and tabs, meant to be used in scripts.
.PP
For this script-friendly display, if 'all' is specified, then the first field for all categories of information is the interface name.
.PP
If 'dump' is specified, then several lines are printed; the first contains in order separated by tab: private-key, public-key, listen-port, fwmark.
Subsequent lines are printed for each peer and contain in order separated by tab: public-key, preshared-key, endpoint, allowed-ips, latest-handshake, transfer-rx, transfer-tx, persistent-keepalive.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for show
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-wg(1)\fP

49
docs/usage/man/cunicu-wg-showconf.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-wg-showconf - Shows the current configuration and information of the provided WireGuard interface
.SH SYNOPSIS
.PP
\fBcunicu wg showconf interface-name [flags]\fP
.SH DESCRIPTION
.PP
Shows the current configuration of \fB\fCinterface-name\fR in the wg(8) format.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for showconf
.PP
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
Unix control and monitoring socket
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu-wg(1)\fP

49
docs/usage/man/cunicu-wg.1
View File

@@ -1,49 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-wg - WireGuard commands
.SH SYNOPSIS
.PP
\fBcunicu wg [flags]\fP
.SH DESCRIPTION
.PP
The wg sub-command mimics the wg(8) commands of the wireguard-tools package.
In contrast to the wg(8) command, the cunico sub-command delegates it tasks to a running cunucu daemon.
.PP
Currently, only a subset of the wg(8) are supported.
.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
help for wg
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.SH SEE ALSO
.PP
\fBcunicu(1)\fP, \fBcunicu-wg-genkey(1)\fP, \fBcunicu-wg-genpsk(1)\fP, \fBcunicu-wg-pubkey(1)\fP, \fBcunicu-wg-show(1)\fP, \fBcunicu-wg-showconf(1)\fP

62
docs/usage/man/cunicu.1
View File

@@ -1,62 +0,0 @@
.nh
.TH "cunīcu" "1" "Oct 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.
.SH SYNOPSIS
.PP
\fBcunicu [flags]\fP
.SH DESCRIPTION
.PP
.RS
.nf
(\\(\\ ▟▀▀▙ █ █ █▀▀▙ ▀▀▀ ▟▀▀▙ █ ▙
(-,-) █ █ █ █ █ ▀█ █ █ █ (\\_/)
o_(")(") ▜▄▄▛ ▜▄▄▛ █ █ ▄█▄ ▜▄▄▛ ▜▄▄▛ (•_•)
zero-conf • p2p • mesh • vpn /> ❤️ WireGuard™
.fi
.RE
.PP
cunīcu is a user-space daemon managing WireGuard® interfaces to
establish peer-to-peer connections in harsh network environments.
.PP
It relies on the awesome pion/ice package for the interactive
connectivity establishment as well as bundles the Go user-space
implementation of WireGuard in a single binary for environments
in which WireGuard kernel support has not landed yet.
.SH OPTIONS
.PP
\fB-q\fP, \fB--color\fP="auto"
Enable colorization of output (one of: auto, always, never)
.PP
\fB-l\fP, \fB--log-file\fP=""
path of a file to write logs to
.PP
\fB-d\fP, \fB--log-level\fP="info"
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
.PP
\fB-v\fP, \fB--verbose\fP=0
verbosity level
.PP
\fB-h\fP, \fB--help\fP[=false]
help for cunicu
.SH SEE ALSO
.PP
\fBcunicu-addresses(1)\fP, \fBcunicu-completion(1)\fP, \fBcunicu-config(1)\fP, \fBcunicu-daemon(1)\fP, \fBcunicu-invite(1)\fP, \fBcunicu-monitor(1)\fP, \fBcunicu-relay(1)\fP, \fBcunicu-restart(1)\fP, \fBcunicu-selfupdate(1)\fP, \fBcunicu-signal(1)\fP, \fBcunicu-status(1)\fP, \fBcunicu-stop(1)\fP, \fBcunicu-sync(1)\fP, \fBcunicu-version(1)\fP, \fBcunicu-wg(1)\fP

57
docs/usage/md/cunicu.md
View File

@@ -1,57 +0,0 @@
---
title: cunicu
sidebar_class_name: command-name
slug: /usage/man/
hide_title: true
keywords:
- manpage
---
## cunicu
cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.
### Synopsis
(\(\ ▟▀▀▙ █ █ █▀▀▙ ▀▀▀ ▟▀▀▙ █ ▙
(-,-) █ █ █ █ █ ▀█ █ █ █ (\_/)
o_(")(") ▜▄▄▛ ▜▄▄▛ █ █ ▄█▄ ▜▄▄▛ ▜▄▄▛ (•_•)
zero-conf • p2p • mesh • vpn /> ❤️ WireGuard™
cunīcu is a user-space daemon managing WireGuard® interfaces to
establish peer-to-peer connections in harsh network environments.
It relies on the awesome pion/ice package for the interactive
connectivity establishment as well as bundles the Go user-space
implementation of WireGuard in a single binary for environments
in which WireGuard kernel support has not landed yet.
### Options
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
-h, --help help for cunicu
```
### SEE ALSO
* [cunicu addresses](cunicu_addresses.md) - Derive IPv4 and IPv6 addresses from a WireGuard X25519 public key
* [cunicu completion](cunicu_completion.md) - Generate the autocompletion script for the specified shell
* [cunicu config](cunicu_config.md) - Manage configuration of a running cunīcu daemon.
* [cunicu daemon](cunicu_daemon.md) - Start the daemon
* [cunicu invite](cunicu_invite.md) - Add a new peer to the local daemon configuration and return the required configuration for this new peer
* [cunicu monitor](cunicu_monitor.md) - Monitor the cunīcu daemon for events
* [cunicu relay](cunicu_relay.md) - Start relay API server
* [cunicu restart](cunicu_restart.md) - Restart the cunīcu daemon
* [cunicu selfupdate](cunicu_selfupdate.md) - Update the cunīcu binary
* [cunicu signal](cunicu_signal.md) - Start gRPC signaling server
* [cunicu status](cunicu_status.md) - Show current status of the cunīcu daemon, its interfaces and peers
* [cunicu stop](cunicu_stop.md) - Shutdown the cunīcu daemon
* [cunicu sync](cunicu_sync.md) - Synchronize cunīcu daemon state
* [cunicu version](cunicu_version.md) - Show version of the cunīcu binary and optionally also a running daemon
* [cunicu wg](cunicu_wg.md) - WireGuard commands

52
docs/usage/md/cunicu_addresses.md
View File

@@ -1,52 +0,0 @@
---
title: cunicu addresses
sidebar_label: addresses
sidebar_class_name: command-name
slug: /usage/man/addresses
hide_title: true
keywords:
- manpage
---
## cunicu addresses
Derive IPv4 and IPv6 addresses from a WireGuard X25519 public key
### Synopsis
cunīcu auto-configuration feature derives and assigns IPv4 and IPv6 addresses based on the public key of the WireGuard interface.
This sub-command accepts a WireGuard public key on the standard input and prints out the calculated IP addresses on the standard output.
```
cunicu addresses [flags]
```
### Examples
```
$ wg genkey | wg pubkey | cunicu addresses
fc2f:9a4d:777f:7a97:8197:4a5d:1d1b:ed79
10.237.119.127
```
### Options
```
-h, --help help for addresses
-m, --mask Print CIDR mask
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

43
docs/usage/md/cunicu_completion.md
View File

@@ -1,43 +0,0 @@
---
title: cunicu completion
sidebar_label: completion
sidebar_class_name: command-name
slug: /usage/man/completion
hide_title: true
keywords:
- manpage
---
## cunicu completion
Generate the autocompletion script for the specified shell
### Synopsis
Generate the autocompletion script for cunicu for the specified shell.
See each sub-command's help for details on how to use the generated script.
### Options
```
-h, --help help for completion
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.
* [cunicu completion bash](cunicu_completion_bash.md) - Generate the autocompletion script for bash
* [cunicu completion fish](cunicu_completion_fish.md) - Generate the autocompletion script for fish
* [cunicu completion powershell](cunicu_completion_powershell.md) - Generate the autocompletion script for powershell
* [cunicu completion zsh](cunicu_completion_zsh.md) - Generate the autocompletion script for zsh

62
docs/usage/md/cunicu_completion_bash.md
View File

@@ -1,62 +0,0 @@
---
title: cunicu completion bash
sidebar_label: completion bash
sidebar_class_name: command-name
slug: /usage/man/completion/bash
hide_title: true
keywords:
- manpage
---
## cunicu completion bash
Generate the autocompletion script for bash
### Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
source <(cunicu completion bash)
To load completions for every new session, execute once:
#### Linux:
cunicu completion bash > /etc/bash_completion.d/cunicu
#### macOS:
cunicu completion bash > $(brew --prefix)/etc/bash_completion.d/cunicu
You will need to start a new shell for this setup to take effect.
```
cunicu completion bash
```
### Options
```
-h, --help help for bash
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu completion](cunicu_completion.md) - Generate the autocompletion script for the specified shell

53
docs/usage/md/cunicu_completion_fish.md
View File

@@ -1,53 +0,0 @@
---
title: cunicu completion fish
sidebar_label: completion fish
sidebar_class_name: command-name
slug: /usage/man/completion/fish
hide_title: true
keywords:
- manpage
---
## cunicu completion fish
Generate the autocompletion script for fish
### Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
cunicu completion fish | source
To load completions for every new session, execute once:
cunicu completion fish > ~/.config/fish/completions/cunicu.fish
You will need to start a new shell for this setup to take effect.
```
cunicu completion fish [flags]
```
### Options
```
-h, --help help for fish
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu completion](cunicu_completion.md) - Generate the autocompletion script for the specified shell

50
docs/usage/md/cunicu_completion_powershell.md
View File

@@ -1,50 +0,0 @@
---
title: cunicu completion powershell
sidebar_label: completion powershell
sidebar_class_name: command-name
slug: /usage/man/completion/powershell
hide_title: true
keywords:
- manpage
---
## cunicu completion powershell
Generate the autocompletion script for powershell
### Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
cunicu completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.
```
cunicu completion powershell [flags]
```
### Options
```
-h, --help help for powershell
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu completion](cunicu_completion.md) - Generate the autocompletion script for the specified shell

64
docs/usage/md/cunicu_completion_zsh.md
View File

@@ -1,64 +0,0 @@
---
title: cunicu completion zsh
sidebar_label: completion zsh
sidebar_class_name: command-name
slug: /usage/man/completion/zsh
hide_title: true
keywords:
- manpage
---
## cunicu completion zsh
Generate the autocompletion script for zsh
### Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(cunicu completion zsh); compdef _cunicu cunicu
To load completions for every new session, execute once:
#### Linux:
cunicu completion zsh > "${fpath[1]}/_cunicu"
#### macOS:
cunicu completion zsh > $(brew --prefix)/share/zsh/site-functions/_cunicu
You will need to start a new shell for this setup to take effect.
```
cunicu completion zsh [flags]
```
### Options
```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu completion](cunicu_completion.md) - Generate the autocompletion script for the specified shell

42
docs/usage/md/cunicu_config.md
View File

@@ -1,42 +0,0 @@
---
title: cunicu config
sidebar_label: config
sidebar_class_name: command-name
slug: /usage/man/config
hide_title: true
keywords:
- manpage
---
## cunicu config
Manage configuration of a running cunīcu daemon.
### Synopsis
### Options
```
-h, --help help for config
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.
* [cunicu config get](cunicu_config_get.md) - Get current value of a configuration setting
* [cunicu config reload](cunicu_config_reload.md) - Reload the configuration of the cunīcu daemon
* [cunicu config set](cunicu_config_set.md) - Update the value of a configuration setting

38
docs/usage/md/cunicu_config_get.md
View File

@@ -1,38 +0,0 @@
---
title: cunicu config get
sidebar_label: config get
sidebar_class_name: command-name
slug: /usage/man/config/get
hide_title: true
keywords:
- manpage
---
## cunicu config get
Get current value of a configuration setting
```
cunicu config get [key] [flags]
```
### Options
```
-h, --help help for get
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu config](cunicu_config.md) - Manage configuration of a running cunīcu daemon.

38
docs/usage/md/cunicu_config_reload.md
View File

@@ -1,38 +0,0 @@
---
title: cunicu config reload
sidebar_label: config reload
sidebar_class_name: command-name
slug: /usage/man/config/reload
hide_title: true
keywords:
- manpage
---
## cunicu config reload
Reload the configuration of the cunīcu daemon
```
cunicu config reload [flags]
```
### Options
```
-h, --help help for reload
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu config](cunicu_config.md) - Manage configuration of a running cunīcu daemon.

38
docs/usage/md/cunicu_config_set.md
View File

@@ -1,38 +0,0 @@
---
title: cunicu config set
sidebar_label: config set
sidebar_class_name: command-name
slug: /usage/man/config/set
hide_title: true
keywords:
- manpage
---
## cunicu config set
Update the value of a configuration setting
```
cunicu config set key value [flags]
```
### Options
```
-h, --help help for set
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu config](cunicu_config.md) - Manage configuration of a running cunīcu daemon.

63
docs/usage/md/cunicu_daemon.md
View File

@@ -1,63 +0,0 @@
---
title: cunicu daemon
sidebar_label: daemon
sidebar_class_name: command-name
slug: /usage/man/daemon
hide_title: true
keywords:
- manpage
---
## cunicu daemon
Start the daemon
```
cunicu daemon [interface-names...] [flags]
```
### Examples
```
$ cunicu daemon -u -x mysecretpass wg0
```
### Options
```
-b, --backend URL One or more URLs to signaling backends
-x, --community passphrase A passphrase shared with other peers in the same community
-c, --config filename One or more filenames of configuration files
-E, --discover-endpoints Enable ICE endpoint discovery (default true)
-P, --discover-peers Enable peer discovery (default true)
-D, --domain domain A DNS domain name used for DNS auto-configuration
--ice-candidate-type candidate-type Usable candidate-types (one of host, srflx, prflx, relay)
--ice-network-type network-type Usable network-types (one of udp4, udp6, tcp4, tcp6)
-a, --ice-url URL One or more URLs of STUN and/or TURN servers
-p, --password password The password for STUN/TURN credentials
-T, --routing-table int Kernel routing table to use (default 254)
-s, --rpc-socket path The path of the unix socket used by other cunicu commands
--rpc-wait Wait until first client connected to control socket before continuing start
-C, --sync-config Enable synchronization of configuration files (default true)
-H, --sync-hosts Enable synchronization of /etc/hosts file (default true)
-R, --sync-routes Enable synchronization of AllowedIPs with Kernel routes (default true)
-u, --username username The username for STUN/TURN credentials
-w, --watch-config Watch configuration files for changes and apply changes at runtime.
-i, --watch-interval duration An interval at which we are periodically polling the kernel for updates on WireGuard interfaces
-U, --wg-userspace Use user-space WireGuard implementation for newly created interfaces
-h, --help help for daemon
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

40
docs/usage/md/cunicu_invite.md
View File

@@ -1,40 +0,0 @@
---
title: cunicu invite
sidebar_label: invite
sidebar_class_name: command-name
slug: /usage/man/invite
hide_title: true
keywords:
- manpage
---
## cunicu invite
Add a new peer to the local daemon configuration and return the required configuration for this new peer
```
cunicu invite [interface] [flags]
```
### Options
```
-h, --help help for invite
-L, --listen-port int Listen port for generated config (default 51820)
-Q, --qr-code Show config as QR code in terminal
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

39
docs/usage/md/cunicu_monitor.md
View File

@@ -1,39 +0,0 @@
---
title: cunicu monitor
sidebar_label: monitor
sidebar_class_name: command-name
slug: /usage/man/monitor
hide_title: true
keywords:
- manpage
---
## cunicu monitor
Monitor the cunīcu daemon for events
```
cunicu monitor [flags]
```
### Options
```
-f, --format format Output format (one of: json, logger, human) (default "human")
-h, --help help for monitor
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

66
docs/usage/md/cunicu_relay.md
View File

@@ -1,66 +0,0 @@
---
title: cunicu relay
sidebar_label: relay
sidebar_class_name: command-name
slug: /usage/man/relay
hide_title: true
keywords:
- manpage
---
## cunicu relay
Start relay API server
### Synopsis
This command starts a gRPC server providing cunicu agents with a list of available STUN and TURN servers.
**Note:** Currently this command does not run a TURN server itself. But relies on an external server like Coturn.
With this feature you can distribute a list of available STUN/TURN servers easily to a fleet of agents.
It also allows to issue short-lived HMAC-SHA1 credentials based the proposed TURN REST API and thereby static long term credentials.
The command expects a list of STUN or TURN URLs according to RFC7065/RFC7064 with a few extensions:
- A secret for the TURN REST API can be provided by the 'secret' query parameter
- Example: turn:server.com?secret=rest-api-secret
- A time-to-live to the TURN REST API secrets can be provided by the 'ttl' query parameter
- Example: turn:server.com?ttl=1h
- Static TURN credentials can be provided by the URIs user info
- Example: turn:user1:pass1@server.com
```
cunicu relay URL... [flags]
```
### Examples
```
relay turn:server.com?secret=rest-api-secret&ttl=1h
```
### Options
```
-h, --help help for relay
-L, --listen string listen address (default ":8080")
-S, --secure listen with TLS
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

38
docs/usage/md/cunicu_reload.md
View File

@@ -1,38 +0,0 @@
---
title: cunicu reload
sidebar_label: reload
sidebar_class_name: command-name
slug: /usage/man/reload
hide_title: true
keywords:
- manpage
---
## cunicu reload
Reload the configuration of the cunīcu daemon
```
cunicu reload [flags]
```
### Options
```
-h, --help help for reload
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-C, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

38
docs/usage/md/cunicu_restart.md
View File

@@ -1,38 +0,0 @@
---
title: cunicu restart
sidebar_label: restart
sidebar_class_name: command-name
slug: /usage/man/restart
hide_title: true
keywords:
- manpage
---
## cunicu restart
Restart the cunīcu daemon
```
cunicu restart [flags]
```
### Options
```
-h, --help help for restart
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

46
docs/usage/md/cunicu_self-update.md
View File

@@ -1,46 +0,0 @@
---
title: cunicu self-update
sidebar_label: self-update
sidebar_class_name: command-name
slug: /usage/man/self-update
hide_title: true
keywords:
- manpage
---
## cunicu self-update
Update the cunīcu binary
### Synopsis
The command "self-update" downloads the latest stable release of cunicu from
GitHub and replaces the currently running binary. After download, the
authenticity of the binary is verified using the GPG signature on the release
files.
```
cunicu self-update [flags]
```
### Options
```
-h, --help help for self-update
-o, --output filename Save the downloaded file as filename (default "cunicu")
```
### Options inherited from parent commands
```
-C, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

43
docs/usage/md/cunicu_selfupdate.md
View File

@@ -1,43 +0,0 @@
---
title: cunicu selfupdate
sidebar_label: selfupdate
sidebar_class_name: command-name
slug: /usage/man/selfupdate
hide_title: true
keywords:
- manpage
---
## cunicu selfupdate
Update the cunīcu binary
### Synopsis
Downloads the latest stable release of cunīcu from GitHub and replaces the currently running binary.
After download, the authenticity of the binary is verified using the GPG signature on the release files.
```
cunicu selfupdate [flags]
```
### Options
```
-h, --help help for selfupdate
-o, --output filename Save the downloaded file as filename (default "cunicu")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

39
docs/usage/md/cunicu_signal.md
View File

@@ -1,39 +0,0 @@
---
title: cunicu signal
sidebar_label: signal
sidebar_class_name: command-name
slug: /usage/man/signal
hide_title: true
keywords:
- manpage
---
## cunicu signal
Start gRPC signaling server
```
cunicu signal [flags]
```
### Options
```
-h, --help help for signal
-L, --listen string listen address (default ":8080")
-S, --secure listen with TLS
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

40
docs/usage/md/cunicu_status.md
View File

@@ -1,40 +0,0 @@
---
title: cunicu status
sidebar_label: status
sidebar_class_name: command-name
slug: /usage/man/status
hide_title: true
keywords:
- manpage
---
## cunicu status
Show current status of the cunīcu daemon, its interfaces and peers
```
cunicu status [interface-name [peer-public-key]] [flags]
```
### Options
```
-f, --format format Output format (one of: human, json) (default "human")
-h, --help help for status
-i, --indent Format and indent JSON ouput (default true)
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

38
docs/usage/md/cunicu_stop.md
View File

@@ -1,38 +0,0 @@
---
title: cunicu stop
sidebar_label: stop
sidebar_class_name: command-name
slug: /usage/man/stop
hide_title: true
keywords:
- manpage
---
## cunicu stop
Shutdown the cunīcu daemon
```
cunicu stop [flags]
```
### Options
```
-h, --help help for stop
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

42
docs/usage/md/cunicu_sync.md
View File

@@ -1,42 +0,0 @@
---
title: cunicu sync
sidebar_label: sync
sidebar_class_name: command-name
slug: /usage/man/sync
hide_title: true
keywords:
- manpage
---
## cunicu sync
Synchronize cunīcu daemon state
### Synopsis
Synchronizes the internal daemon state with kernel routes, interfaces and addresses
```
cunicu sync [flags]
```
### Options
```
-h, --help help for sync
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

47
docs/usage/md/cunicu_version.md
View File

@@ -1,47 +0,0 @@
---
title: cunicu version
sidebar_label: version
sidebar_class_name: command-name
slug: /usage/man/version
hide_title: true
keywords:
- manpage
---
## cunicu version
Show version of the cunīcu binary and optionally also a running daemon
```
cunicu version [flags]
```
### Examples
```
$ sudo cunicu version
client: v0.1.2 (os=linux, arch=arm64, commit=b22ee3e7, branch=master, built-at=2022-09-09T13:44:22+02:00, built-by=goreleaser)
daemon: v0.1.2 (os=linux, arch=arm64, commit=b22ee3e7, branch=master, built-at=2022-09-09T13:44:22+02:00, built-by=goreleaser)
```
### Options
```
-f, --format format Output format (one of: human, json) (default "human")
-h, --help help for version
-s, --short Only show version and nothing else
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.

45
docs/usage/md/cunicu_wg.md
View File

@@ -1,45 +0,0 @@
---
title: cunicu wg
sidebar_label: wg
sidebar_class_name: command-name
slug: /usage/man/wg
hide_title: true
keywords:
- manpage
---
## cunicu wg
WireGuard commands
### Synopsis
The wg sub-command mimics the wg(8) commands of the wireguard-tools package.
In contrast to the wg(8) command, the cunico sub-command delegates it tasks to a running cunucu daemon.
Currently, only a subset of the wg(8) are supported.
### Options
```
-h, --help help for wg
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.
* [cunicu wg genkey](cunicu_wg_genkey.md) - Generates a random private key in base64 and prints it to standard output.
* [cunicu wg genpsk](cunicu_wg_genpsk.md) - Generates a random preshared key in base64 and prints it to standard output.
* [cunicu wg pubkey](cunicu_wg_pubkey.md) - Calculates a public key and prints it in base64 to standard output.
* [cunicu wg show](cunicu_wg_show.md) - Shows current WireGuard configuration and runtime information of specified [interface].
* [cunicu wg showconf](cunicu_wg_showconf.md) - Shows the current configuration and information of the provided WireGuard interface

37
docs/usage/md/cunicu_wg_genkey.md
View File

@@ -1,37 +0,0 @@
---
title: cunicu wg genkey
sidebar_label: wg genkey
sidebar_class_name: command-name
slug: /usage/man/wg/genkey
hide_title: true
keywords:
- manpage
---
## cunicu wg genkey
Generates a random private key in base64 and prints it to standard output.
```
cunicu wg genkey [flags]
```
### Options
```
-h, --help help for genkey
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu wg](cunicu_wg.md) - WireGuard commands

37
docs/usage/md/cunicu_wg_genpsk.md
View File

@@ -1,37 +0,0 @@
---
title: cunicu wg genpsk
sidebar_label: wg genpsk
sidebar_class_name: command-name
slug: /usage/man/wg/genpsk
hide_title: true
keywords:
- manpage
---
## cunicu wg genpsk
Generates a random preshared key in base64 and prints it to standard output.
```
cunicu wg genpsk [flags]
```
### Options
```
-h, --help help for genpsk
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu wg](cunicu_wg.md) - WireGuard commands

49
docs/usage/md/cunicu_wg_pubkey.md
View File

@@ -1,49 +0,0 @@
---
title: cunicu wg pubkey
sidebar_label: wg pubkey
sidebar_class_name: command-name
slug: /usage/man/wg/pubkey
hide_title: true
keywords:
- manpage
---
## cunicu wg pubkey
Calculates a public key and prints it in base64 to standard output.
### Synopsis
Calculates a public key and prints it in base64 to standard output from a corresponding private key (generated with genkey) given in base64 on standard input.
```
cunicu wg pubkey [flags]
```
### Examples
```
# A private key and a corresponding public key may be generated at once by calling:
$ umask 077
$ wg genkey | tee private.key | wg pubkey > public.key
```
### Options
```
-h, --help help for pubkey
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu wg](cunicu_wg.md) - WireGuard commands

54
docs/usage/md/cunicu_wg_show.md
View File

@@ -1,54 +0,0 @@
---
title: cunicu wg show
sidebar_label: wg show
sidebar_class_name: command-name
slug: /usage/man/wg/show
hide_title: true
keywords:
- manpage
---
## cunicu wg show
Shows current WireGuard configuration and runtime information of specified [interface].
### Synopsis
Shows current WireGuard configuration and runtime information of specified [interface].
If no [interface] is specified, [interface] defaults to 'all'.
If 'interfaces' is specified, prints a list of all WireGuard interfaces, one per line, and quits.
If no options are given after the interface specification, then prints a list of all attributes in a visually pleasing way meant for the terminal.
Otherwise, prints specified information grouped by newlines and tabs, meant to be used in scripts.
For this script-friendly display, if 'all' is specified, then the first field for all categories of information is the interface name.
If 'dump' is specified, then several lines are printed; the first contains in order separated by tab: private-key, public-key, listen-port, fwmark.
Subsequent lines are printed for each peer and contain in order separated by tab: public-key, preshared-key, endpoint, allowed-ips, latest-handshake, transfer-rx, transfer-tx, persistent-keepalive.
```
cunicu wg show { interface-name | all | interfaces } [{ public-key | private-key | listen-port | fwmark | peers | preshared-keys | endpoints | allowed-ips | latest-handshakes | transfer | persistent-keepalive | dump }] [flags]
```
### Options
```
-h, --help help for show
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu wg](cunicu_wg.md) - WireGuard commands

42
docs/usage/md/cunicu_wg_showconf.md
View File

@@ -1,42 +0,0 @@
---
title: cunicu wg showconf
sidebar_label: wg showconf
sidebar_class_name: command-name
slug: /usage/man/wg/showconf
hide_title: true
keywords:
- manpage
---
## cunicu wg showconf
Shows the current configuration and information of the provided WireGuard interface
### Synopsis
Shows the current configuration of `interface-name` in the wg(8) format.
```
cunicu wg showconf interface-name [flags]
```
### Options
```
-h, --help help for showconf
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
```
### Options inherited from parent commands
```
-q, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
-l, --log-file string path of a file to write logs to
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
-v, --verbose int verbosity level
```
### SEE ALSO
* [cunicu wg](cunicu_wg.md) - WireGuard commands