v0.1.0

CLI Reference

Last updated


This page lists how to launch go-web-monitor and every command and key binding available in the Command input.

Launch


CommandDescription
go run ./cmd/tuiRun directly from source
./go-web-monitorRun the built binary

The program takes no flags or arguments, and its data file is always .webMonitor.json in the current working directory.

Main Commands


CommandSyntaxDescription
addadd <url>Adds a site and checks it once; an existing URL is not added twice
delete / del / remove / rmdel <url>Removes a site; the URL must match the list entry exactly
smtp / smtp showsmtpSwitches to the SMTP view
smtpsmtp <key> <value>Sets an SMTP field or manages recipients
testtestSends a test email in the background
refreshrefreshRe-checks every site in the background now
backbackReturns from the SMTP view to the main view
quit / exit / byequitExits the program

Unlisted commands are ignored without an error.

SMTP Keys


KeyValueDescription
hostHostnameSMTP host
portIntegerRejected when not an integer
usernameStringAuth username
passwordStringAuth password
fromEmailSender address
enabledtrue / 1 / othertrue or 1 enables; anything else disables
addEmailAdds a recipient (duplicates and blanks ignored)
delete / del / remove / rmEmailRemoves a recipient

Key Bindings


KeyDescription
<kbd>Enter</kbd>Submits the command in the Command input
<kbd>Esc</kbd>Returns from the SMTP view to the main view
<kbd>Ctrl+C</kbd>Exits the program

Error Feedback


When add / del / smtp fail (duplicate URL, URL not found, unknown key, non-integer port), the error goes to stdout through fmt.Printf; test failures go to stderr. Neither appears in the System panel.
中文