Docs: regenerate CLI reference (#3585)

rilldata · Nov 30, 2023 · e1b2227 · e1b2227
1 parent 6fed4f5
commit e1b2227
Show file tree

Hide file tree

Showing 12 changed files with 73 additions and 78 deletions.
diff --git a/cli/cmd/project/refresh.go b/cli/cmd/project/refresh.go
@@ -16,7 +16,7 @@ func RefreshCmd(cfg *config.Config) *cobra.Command {
 	refreshCmd := &cobra.Command{
 		Use:               "refresh [<project-name>]",
 		Args:              cobra.MaximumNArgs(1),
-		Short:             "Refresh project",
+		Short:             "Refresh the project's data sources",
 		PersistentPreRunE: cmdutil.CheckChain(cmdutil.CheckAuth(cfg), cmdutil.CheckOrganization(cfg)),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := cmd.Context()

diff --git a/cli/cmd/project/reset.go b/cli/cmd/project/reset.go
@@ -16,7 +16,8 @@ func ResetCmd(cfg *config.Config) *cobra.Command {
 	resetCmd := &cobra.Command{
 		Use:               "reset [<project-name>]",
 		Args:              cobra.MaximumNArgs(1),
-		Short:             "Reset project",
+		Short:             "Re-deploy project",
+		Long:              "Create a new deployment for the project (and tear down the current one)",
 		PersistentPreRunE: cmdutil.CheckChain(cmdutil.CheckAuth(cfg), cmdutil.CheckOrganization(cfg)),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := cmd.Context()

diff --git a/docs/docs/reference/cli/cli.md b/docs/docs/reference/cli/cli.md
@@ -24,7 +24,8 @@ Rill CLI
 * [rill org](org/org.md)	 - Manage organisations
 * [rill project](project/project.md)	 - Manage projects
 * [rill start](start.md)	 - Build project and start web app
+* [rill upgrade](upgrade.md)	 - Upgrade Rill to the latest version
 * [rill user](user/user.md)	 - Manage users
-* [rill version](version.md)	 - Show rill version
+* [rill version](version.md)	 - Show Rill version
 * [rill whoami](whoami.md)	 - Show current user
 
diff --git a/docs/docs/reference/cli/project/describe.md b/docs/docs/reference/cli/project/describe.md
@@ -5,15 +5,19 @@ title: rill project describe
 
 Retrieve detailed state for a resource
 
+### Synopsis
+
+Retrieve detailed state for a specific resource (source, model, dashboard, ...)
+
 ```
 rill project describe [<project-name>] <kind> <name> [flags]
 ```
 
 ### Flags
 
 ```
-      --path string       Project directory (default ".")
-      --project string    Project name
+      --path string      Project directory (default ".")
+      --project string   Project name
 ```
 
 ### Global flags
@@ -27,4 +31,5 @@ rill project describe [<project-name>] <kind> <name> [flags]
 
 ### SEE ALSO
 
-* [rill project](project.md)	 - Manage projects
+* [rill project](project.md)	 - Manage projects
+
diff --git a/docs/docs/reference/cli/project/logs.md b/docs/docs/reference/cli/project/logs.md
@@ -3,7 +3,7 @@ title: rill project logs
 ---
 ## rill project logs
 
-Show project logs (up to 10k rows)
+Show project logs
 
 ```
 rill project logs [<project-name>] [flags]
@@ -29,4 +29,5 @@ rill project logs [<project-name>] [flags]
 
 ### SEE ALSO
 
-* [rill project](project.md)	 - Manage projects
+* [rill project](project.md)	 - Manage projects
+
diff --git a/docs/docs/reference/cli/project/project.md b/docs/docs/reference/cli/project/project.md
@@ -21,16 +21,15 @@ Manage projects
 
 ### SEE ALSO
 
-* [rill](../cli.md)	                               - Rill CLI
-* [rill project delete](delete.md)	                   - Delete the project
-* [rill project describe](describe.md)                 - Retrieve detailed state for a resource
-* [rill project edit](edit.md)	                   - Edit the project details
-* [rill project list](list.md)	                   - List all the projects
-* [rill project logs](logs.md)	                   - Show project logs
-* [rill project refresh](refresh.md)	             - Refresh project
-* [rill project rename](rename.md)	                   - Rename project
-* [rill project reset](reset.md)	                   - Reset project
-* [rill project show](show.md)	                   - Show project details
-* [rill project status](status.md)	                   - Project deployment status
-* [rill project reconcile (deprecated)](reconcile.md)	 - Send trigger to deployment
+* [rill](../cli.md)	 - Rill CLI
+* [rill project delete](delete.md)	 - Delete the project
+* [rill project describe](describe.md)	 - Retrieve detailed state for a resource
+* [rill project edit](edit.md)	 - Edit the project details
+* [rill project list](list.md)	 - List all the projects
+* [rill project logs](logs.md)	 - Show project logs
+* [rill project refresh](refresh.md)	 - Refresh the project's data sources
+* [rill project rename](rename.md)	 - Rename project
+* [rill project reset](reset.md)	 - Re-deploy project
+* [rill project show](show.md)	 - Show project details
+* [rill project status](status.md)	 - Project deployment status
 
diff --git a/docs/docs/reference/cli/project/reconcile.md b/docs/docs/reference/cli/project/reconcile.md
diff --git a/docs/docs/reference/cli/project/refresh.md b/docs/docs/reference/cli/project/refresh.md
@@ -3,7 +3,7 @@ title: rill project refresh
 ---
 ## rill project refresh
 
-Refresh the data in your project
+Refresh the project's data sources
 
 ```
 rill project refresh [<project-name>] [flags]
@@ -12,9 +12,9 @@ rill project refresh [<project-name>] [flags]
 ### Flags
 
 ```
-      --project string           Project name
-      --path string              Project directory (default ".")
-      --source strings           Refresh specific source(s)
+      --project string   Project name
+      --path string      Project directory (default ".")
+      --source strings   Refresh specific source(s)
 ```
 
 ### Global flags
@@ -29,4 +29,4 @@ rill project refresh [<project-name>] [flags]
 ### SEE ALSO
 
 * [rill project](project.md)	 - Manage projects
-* [rill project reset](reset.md) - Reset project
+
diff --git a/docs/docs/reference/cli/project/reset.md b/docs/docs/reference/cli/project/reset.md
@@ -3,7 +3,11 @@ title: rill project reset
 ---
 ## rill project reset
 
-Trigger a new deployment and/or reset your project
+Re-deploy project
+
+### Synopsis
+
+Create a new deployment for the project (and tear down the current one)
 
 ```
 rill project reset [<project-name>] [flags]
@@ -12,9 +16,9 @@ rill project reset [<project-name>] [flags]
 ### Flags
 
 ```
-      --project string           Project name
-      --path string              Project directory (default ".")
-      --force                    Force reset even if project is already deployed
+      --project string   Project name
+      --path string      Project directory (default ".")
+      --force            Force reset even if project is already deployed
 ```
 
 ### Global flags
@@ -28,5 +32,5 @@ rill project reset [<project-name>] [flags]
 
 ### SEE ALSO
 
-* [rill project](project.md)	     - Manage projects
-* [rill project refresh](refresh.md) - Refresh project
+* [rill project](project.md)	 - Manage projects
+
diff --git a/docs/docs/reference/cli/start.md b/docs/docs/reference/cli/start.md
@@ -13,14 +13,14 @@ rill start [<path>] [flags]
 
 ```
       --no-open             Do not open browser
-      --db string           Database DSN (default "stage.db")
+      --db string           Database DSN (default "main.db")
       --db-driver string    Database driver (default "duckdb")
       --port int            Port for HTTP (default 9009)
       --port-grpc int       Port for gRPC (internal) (default 49009)
       --readonly            Show only dashboards in UI
       --no-ui               Serve only the backend
       --verbose             Sets the log level to debug
-      --strict              Exit if project has build errors
+      --reset               Clear and re-ingest source data
       --log-format string   Log format (options: "console", "json") (default "console")
   -e, --env strings         Set project variables
 ```

diff --git a/docs/docs/reference/cli/upgrade.md b/docs/docs/reference/cli/upgrade.md
@@ -0,0 +1,28 @@
+---
+title: rill upgrade
+---
+## rill upgrade
+
+Upgrade Rill to the latest version
+
+```
+rill upgrade [flags]
+```
+
+### Flags
+
+```
+      --nightly   Install the latest nightly build
+```
+
+### Global flags
+
+```
+  -h, --help          Print usage
+      --interactive   Prompt for missing required parameters (default true)
+```
+
+### SEE ALSO
+
+* [rill](cli.md)	 - Rill CLI
+
diff --git a/docs/docs/reference/cli/version.md b/docs/docs/reference/cli/version.md
@@ -3,11 +3,7 @@ title: rill version
 ---
 ## rill version
 
-Show rill version
-
-### Synopsis
-
-A longer description
+Show Rill version
 
 ```
 rill version [flags]