Commit Diff


commit - f05dbe30f4e66918657dcbc27477af1c0212b1aa
commit + 87b0d16740f9a21ba5dda5cf670c0e3a58752e38
blob - 63dd8bd3b4ca6a2fd88690b01ba818bfdba8c2be
blob + 15c7e450650bc1f1f1c0ce9b462fa80f2fec7eb8
--- README.md
+++ README.md
@@ -2,6 +2,14 @@
 
 Package dishy provides an interface to manage a Starlink Dishy device over the network.
 
+## `dishy` command
+
+The `dishy` command controls a dishy device over the network.
+
+To install using the go tools:
+
+	go install olowe.co/dishy/cmd/dishy@latest
+
 ## gRPC Code Generation
 
 A starlink device supports gRPC [server reflection][reflection].
blob - /dev/null
blob + 9534fb0d1ac62309fd51d135b4637ea51f9eaaac (mode 644)
--- /dev/null
+++ cmd/dishy/doc.go
@@ -0,0 +1,31 @@
+/*
+Command dishy provides a command line interface to controlling and monitoring a Starlink Dishy device over the network. Its usage is:
+
+	dishy [-a address] command
+
+The following commands are understood:
+
+	reboot
+		Request dishy to be rebooted immediately.
+	stow
+		Reposition dish in a vertical orientation for easier transport.
+	unstow
+		Reposition the dish in the orientation prior to unstowing.
+
+The flag -a specifies the address to connect to dishy.
+By default this is the default IPv4 address and port that dishy listens on 192.168.100.1:9200.
+
+# Examples
+
+Unstow the device, wait 10 seconds, then reboot it:
+
+	dishy unstow
+	sleep 10
+	dishy reboot
+
+Stow the device accessible through a tunneled connection via the loopback address:
+
+	dishy -a 127.0.0.1:9200 stow
+
+*/
+package main