.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "comitup-cli" "1" "Aug 2021" "" ""
.hy
.SH NAME
.PP
comitup-cli \- command-line interface for comitup network management
.SS SYNOPSIS
.IP
.nf
\f[C]
$ \[ga]comitup-cli [cmd ...]\[ga]

State: HOTSPOT
Connection: hotspot-123
Points:
    1: MyAccessPoint
    2: HisAccessPoint
Available Commands:
    (r)eload
    (q)uit
    connect to (<n>)
    [l]ocate the device
    [x] Factory reset (no warning)
command?:
\f[R]
.fi
.SS DESCRIPTION
.PP
The \f[B]comitup-cli\f[R] utility provides access to the comitup(8)
D-Bus interface.
It is intended to serve as a debug tool, and a source code example for
connecting to the interface.
.PP
If an argument is provided, a one-shot command is attempted.
Oherwise, the program goes into an interpretive mode.
.PP
If the comitup(8) service is not running, \f[B]comitup-cli\f[R] will
immediately exit.
.SS Command-Mode Display:
.IP \[bu] 2
\f[B]State\f[R]
.RS 2
.PP
The \f[B]comitup\f[R] states are \f[B]HOTSPOT\f[R],
\f[B]CONNECTING\f[R], and \f[B]CONNECTED\f[R].
.PP
In the \f[B]HOTSPOT\f[R] mode, \f[B]comitup\f[R] creates a wifi hotspot
with the name \f[B]comitup-<nnn>\f[R], where <nnn> is a persistent
number.
.PP
Once in \f[B]HOTSPOT\f[R] mode, the system will occasionally (\[ti]3
min) cycle through available defined connections, by transitioning to
the \f[B]CONNECTING\f[R] mode.
The Access Point list is updated by this process.
Any command issued by \f[B]comitup-cli\f[R] will cause the next timeout
instance to be skipped.
.PP
If any other devices are connected to the Comitup hotspot, the periodic
attempt is skipped, to avoid interrupting service to those devices.
.PP
Once a connection is established, the system will be in the
\f[B]CONNECTED\f[R] mode.
If the connection is lost, failed, or deleted, the system will
transition back to the \f[B]HOTSPOT\f[R] state.
.RE
.IP \[bu] 2
\f[B]Connection\f[R]
.RS 2
.PP
The \f[V]ssid\f[R] of the current active connection.
.RE
.IP \[bu] 2
\f[B]Points\f[R]
.RS 2
.PP
While in the \f[B]HOTSPOT\f[R] mode, \f[B]comitup-cli\f[R] will list the
currently-visible access points, by \f[V]ssid\f[R].
Access points with the strongest signal are sorted to the top of the
list.
The entries are numbered, for use with the \f[B]connect\f[R] command.
.RE
.SS Commands
.IP \[bu] 2
\f[B]r\f[R] - \f[B]Reload\f[R]
.RS 2
.PP
Refresh the displayed state, mode, and list of access points.
.RE
.IP \[bu] 2
\f[B]q\f[R] - \f[B]Quit\f[R]
.RS 2
.PP
Exit \f[B]comitup.cli\f[R].
.RE
.IP \[bu] 2
\f[B]d\f[R] - \f[B]Delete connection\f[R]
.RS 2
.PP
Delete the configuration information for the current wifi connection.
This will cause \f[B]comitup\f[R] to transition to the \f[B]HOTSPOT\f[R]
mode.
.PP
This command is not available in the \f[B]HOTSPOT\f[R] mode.
.RE
.IP \[bu] 2
\f[B]<n>\f[R] - \f[B]Connect to access point <n>\f[R]
.RS 2
.PP
Define a connection for the selected access point, and then attempt to
connect.
.PP
This command is only available in the \f[B]HOTSPOT\f[R] mode.
.RE
.IP \[bu] 2
\f[B]m\f[R] - \f[B]Manual connection\f[R]
.RS 2
.PP
Enter an SSID manually.
.RE
.IP \[bu] 2
\f[B]i\f[R] - \f[B]Get information\f[R]
.RS 2
.PP
Return the comitup version and host name for the current instance.
.RE
.IP \[bu] 2
\f[B]l\f[R] - \f[B]Locate\f[R]
.RS 2
.PP
Locate the headless Raspberry Pi running Comitup by blinking the front
green LED once.
.RE
.IP \[bu] 2
\f[B]n\f[R] - \f[B]reName\f[R]
.RS 2
.PP
Change the name of the host, Comitup ap_name, and comitup mdns domain
name.
This also adds an entry in `hosts'.
This causes Comitup to restart, and the cli session to end.
.RE
.IP \[bu] 2
\f[B]x\f[R] - \f[B]Factory Reset\f[R]
.RS 2
.PP
Remove all defined WiFi connections, and restart the service.
There is no confirmation requested.
This will terminate the interpreter session.
Note that \f[I]enable_nuke\f[R] must be enabled in
\f[I]comitup.conf\f[R] for this to succeed.
.RE
.SS COPYRIGHT
.PP
Comitup is Copyright (C) 2016-2019 David Steele <steele\[at]debian.org>
.SS SEE ALSO
.PP
comitup(8), comitup-conf(5), comitup-web(8), comitup-watch(1)