comitup-cli(1)

💖 comitup-cli — the manual page (1) 💖

okay bestie, buckle up, we're reading the comitup-cli(1) page together and it's genuinely useful, no cap.

✨ NAME ✨

comitup-cli – command-line interface for comitup network management 🫶

---

🌈 SYNOPSIS 🌈

$ comitup-cli [cmd ...]

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?:

like… look at that prompt. she's literally asking you a question and you're gonna answer it. 💅

---

🎀 DESCRIPTION 🎀

so comitup-cli is the little utility that gives you access to the comitup(8) D-Bus interface. that's her whole deal. she's intended to serve as a debug tool, and also as a source code example for connecting to the interface — so if you're the kind of girl who reads source to learn, this is for you ✨

if you pass an argument, she attempts a one-shot command. otherwise? she goes into interpretive mode and just vibes with you at the prompt.

and um, important: if the comitup(8) service is not running, comitup-cli will immediately exit. she's not gonna sit around waiting, she has standards. 😭

🦋 Command-Mode Display:

• State

the comitup states are HOTSPOT, CONNECTING, and CONNECTED. those are the three, periodt.

in the HOTSPOT mode, comitup creates a wifi hotspot with the name comitup-<nnn>, where <nnn> is a persistent number.

once you're in HOTSPOT mode, the system will occasionally (~3 min) cycle through available defined connections, by transitioning to the CONNECTING mode. the Access Point list gets updated by this process. and here's the tea: any command issued by comitup-cli will cause the next timeout instance to be skipped. 👑

if any other devices are connected to the Comitup hotspot, the periodic attempt is skipped, to avoid interrupting service to those devices. so thoughtful of her.

once a connection is established, the system will be in the CONNECTED mode. and if the connection is lost, failed, or deleted, the system will transition back to the HOTSPOT state. it's giving boomerang. 🪃

• Connection

the ssid of the current active connection. that's it. that's the whole thing. 💖

• Points

while in the HOTSPOT mode, comitup-cli will list the currently-visible access points, by ssid. access points with the strongest signal are sorted to the top of the list, because obviously we put the best ones first. the entries are numbered, for use with the connect command. 🔢

---

🔥 Commands 🔥

• r — Reload — refresh the displayed state, mode, and list of access points. like a little F5 for your soul. 🌸
• q — Quit — exit comitup.cli. bye bestie 🫶
• d — Delete connection — delete the configuration information for the current wifi connection. this will cause comitup to transition to the HOTSPOT mode.

⚠️ this command is not available in the HOTSPOT mode. don't fight it, she said no.

• <n> — Connect to access point <n> — define a connection for the selected access point, and then attempt to connect.

⚠️ this command is only available in the HOTSPOT mode.

• m — Manual connection — enter an SSID manually. for when your network is shy and doesn't show up in the list. 🙈
• i — Get information — return the comitup version and host name for the current instance. receipts! 💅
• l — Locate — locate the headless Raspberry Pi running Comitup by blinking the front green LED once. it's like marco polo but with light. 💚
• n — reName — 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. so don't be surprised when she dips. 😭
• x — Factory Reset — remove all defined WiFi connections, and restart the service. there is no confirmation requested. this will terminate the interpreter session.

💀 note that enable_nuke must be enabled in comitup.conf for this to succeed. yes, it's really called that. read the name and take it seriously, bestie.

---

👑 COPYRIGHT 👑

Comitup is Copyright (C) 2016-2019 David Steele <steele@debian.org>

---

🌟 SEE ALSO 🌟

comitup(8), comitup-conf(5), comitup-web(8), comitup-watch(1)

---

and that's the whole page, gorgeous. this one's from Aug 2021, and it's the comitup-cli(1) manual — General Commands Manual energy all day. slay, stay connected, and remember: if the service isn't running, she's already gone. ✨💖🦋