Debian Codegraph @

doc/comitup-cli.8.md

raw
1 % comitup-cli(1)
2 %
3 % Aug 2021
4
5 # NAME
6
7 comitup-cli -- command-line interface for comitup network management
8
9 ## SYNOPSIS
10
11 $ `comitup-cli [cmd ...]`
12
13 State: HOTSPOT
14 Connection: hotspot-123
15 Points:
16 1: MyAccessPoint
17 2: HisAccessPoint
18 Available Commands:
19 (r)eload
20 (q)uit
21 connect to (<n>)
22 [l]ocate the device
23 [x] Factory reset (no warning)
24 command?:
25
26 ## DESCRIPTION
27
28 The **comitup-cli** utility provides access to the comitup(8) D-Bus interface.
29 It is intended to serve as a debug tool, and a source code example for
30 connecting to the interface.
31
32 If an argument is provided, a one-shot command is attempted. Oherwise, the
33 program goes into an interpretive mode.
34
35 If the comitup(8) service is not running, **comitup-cli** will immediately exit.
36
37 ## Command-Mode Display:
38
39 * **State**
40
41 The **comitup** states are **HOTSPOT**, **CONNECTING**, and **CONNECTED**.
42
43 In the **HOTSPOT** mode, **comitup** creates a wifi hotspot with the
44 name **comitup-&lt;nnn&gt;**, where &lt;nnn&gt; is a persistent number.
45
46 Once in **HOTSPOT** mode, the system will occasionally (~3 min) cycle
47 through available defined connections, by transitioning to the
48 **CONNECTING** mode. The Access Point list is updated by this process.
49 Any command issued by **comitup-cli** will cause the next
50 timeout instance to be skipped.
51
52 If any other devices are connected to the Comitup hotspot, the periodic
53 attempt is skipped, to avoid interrupting service to those devices.
54
55 Once a connection is established, the system will be in the **CONNECTED**
56 mode. If the connection is lost, failed, or deleted, the system will
57 transition back to the **HOTSPOT** state.
58
59 * **Connection**
60
61 The `ssid` of the current active connection.
62
63 * **Points**
64
65 While in the **HOTSPOT** mode, **comitup-cli** will list the
66 currently-visible access points, by `ssid`. Access points with the
67 strongest signal are sorted to the top of the list. The entries are
68 numbered, for use with the __connect__ command.
69
70 ## Commands
71
72 * __r__ - **Reload**
73
74 Refresh the displayed state, mode, and list of access points.
75
76 * __q__ - **Quit**
77
78 Exit **comitup.cli**.
79
80 * __d__ - **Delete connection**
81
82 Delete the configuration information for the current wifi connection.
83 This will cause **comitup** to transition to the **HOTSPOT** mode.
84
85 This command is not available in the **HOTSPOT** mode.
86
87 * __&lt;n&gt;__ - **Connect to access point &lt;n&gt;**
88
89 Define a connection for the selected access point, and then attempt to
90 connect.
91
92 This command is only available in the **HOTSPOT** mode.
93
94 * __m__ - **Manual connection**
95
96 Enter an SSID manually.
97
98 * __i__ - **Get information**
99
100 Return the comitup version and host name for the current instance.
101
102 * __l__ - **Locate**
103
104 Locate the headless Raspberry Pi running Comitup by blinking the front
105 green LED once.
106
107 * __n__ - **reName**
108
109 Change the name of the host, Comitup ap_name, and comitup mdns domain name.
110 This also adds an entry in 'hosts'. This causes Comitup to restart, and the
111 cli session to end.
112
113 * __x__ - **Factory Reset**
114
115 Remove all defined WiFi connections, and restart the service. There is no
116 confirmation requested. This will terminate the interpreter session. Note
117 that _enable_nuke_ must be enabled in _comitup.conf_ for this to succeed.
118
119 ## COPYRIGHT
120
121 Comitup is Copyright (C) 2016-2019 David Steele &lt;[email protected]&gt;
122
123 ## SEE ALSO
124
125 comitup(8), comitup-conf(5), comitup-web(8), comitup-watch(1)
126