add documentation for export command

change export command to be unhidden
treeverse · Nov 12, 2020 · 16d12e5 · 16d12e5
1 parent f1ef8fc
commit 16d12e5
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 4 deletions.
diff --git a/cmd/lakectl/cmd/export.go b/cmd/lakectl/cmd/export.go
@@ -12,10 +12,9 @@ import (
 )
 
 var exportCmd = &cobra.Command{
-	Use:    "export",
-	Hidden: true,
-	Short:  "create and manage continuous export",
-	Long:   `Read set and update continuous export configurations and trigger exports`,
+	Use:   "export",
+	Short: "create and manage continuous export",
+	Long:  `Read set and update continuous export configurations and trigger exports`,
 }
 
 // exportGetCmd get continuous export configuration for branch

diff --git a/docs/reference/commands.md b/docs/reference/commands.md
@@ -846,6 +846,59 @@ Global Flags:
 
 ````
 
+#### `lakectl export get `
+````text
+get continuous export configuration for branch
+
+Usage:
+  lakectl export get <branch uri> [flags]
+
+Flags:
+  -h, --help   help for get
+
+Global Flags:
+  -c, --config string   config file (default is $HOME/.lakectl.yaml)
+  -f, --force           without prompting for confirmation
+      --no-color        don't use fancy output colors (default when not attached to an interactive terminal)
+
+````
+
+#### `lakectl export set `
+````text
+set continuous export configuration for branch
+
+Usage:
+  lakectl export set <branch uri> [flags]
+
+Flags:
+  -h, --help                       help for set
+      --path string                export objects to this path
+      --prefix-regex stringArray   list of regexps of keys to exported last in each prefix (for signalling)
+      --status-path string         write export status object to this path
+
+Global Flags:
+  -c, --config string   config file (default is $HOME/.lakectl.yaml)
+  -f, --force           without prompting for confirmation
+      --no-color        don't use fancy output colors (default when not attached to an interactive terminal)
+
+````
+
+#### `lakectl export run `
+````text
+export requested branch now
+
+Usage:
+  lakectl export run [flags]
+
+Flags:
+  -h, --help   help for run
+
+Global Flags:
+  -c, --config string   config file (default is $HOME/.lakectl.yaml)
+  -f, --force           without prompting for confirmation
+      --no-color        don't use fancy output colors (default when not attached to an interactive terminal)
+
+````
 ### lakeFS URI pattern
 
 Different CLI and UI operations use `lakefs://` URIs.