fix: autostart/autostop: add help and usage, hide for now

johnstcn · johnstcn · commit 027d47d19a66 · 2022-04-08T17:22:36.000+01:00
diff --git a/cli/workspaceautostart.go b/cli/workspaceautostart.go
@@ -10,9 +10,22 @@ import (
 	"github.com/coder/coder/codersdk"
 )
 
+const autostartDescriptionLong = `To have your workspace build automatically at a regular time you can enable autostart.
+When enabling autostart, provide a schedule. This schedule is in cron format except only
+the following fields are allowed:
+- minute
+- hour
+- day of week
+
+For example, to start your workspace every weekday at 9.30 am, provide the schedule '30 9 1-5'.`
+
 func workspaceAutostart() *cobra.Command {
 	autostartCmd := &cobra.Command{
-		Use: "autostart",
+		Use:     "autostart enable <workspace> <schedule>",
+		Short:   "schedule a workspace to automatically start at a regular time",
+		Long:    autostartDescriptionLong,
+		Example: "coder workspaces autostart enable my-workspace '30 9 1-5'",
+		Hidden:  true, // TODO(cian): un-hide when autostart scheduling implemented
 	}
 
 	autostartCmd.AddCommand(workspaceAutostartEnable())
diff --git a/cli/workspaceautostop.go b/cli/workspaceautostop.go
@@ -10,9 +10,22 @@ import (
 	"github.com/coder/coder/codersdk"
 )
 
+const autostopDescriptionLong = `To have your workspace stop automatically at a regular time you can enable autostop.
+When enabling autostop, provide a schedule. This schedule is in cron format except only
+the following fields are allowed:
+- minute
+- hour
+- day of week
+
+For example, to stop your workspace every weekday at 5.30 pm, provide the schedule '30 17 1-5'.`
+
 func workspaceAutostop() *cobra.Command {
 	autostopCmd := &cobra.Command{
-		Use: "autostop",
+		Use:     "autostop enable <workspace> <schedule>",
+		Short:   "schedule a workspace to automatically start at a regular time",
+		Long:    autostopDescriptionLong,
+		Example: "coder workspaces autostop enable my-workspace '30 17 1-5'",
+		Hidden:  true, // TODO(cian): un-hide when autostop scheduling implemented
 	}
 
 	autostopCmd.AddCommand(workspaceAutostopEnable())
