cmd/atlas: add atlas serve docs (#618)

ariga · Mar 3, 2022 · f8cbe54 · f8cbe54
1 parent 2799cd6
commit f8cbe54
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 6 deletions.
diff --git a/cmd/atlas/doc.tmpl b/cmd/atlas/doc.tmpl
@@ -61,4 +61,26 @@ go get ariga.io/atlas/cmd/atlas
 ```
 {{ end }}
 {{ end }}
+## atlas serve
+
+Run Atlas web UI in a standalone mode
+
+#### Usage
+```
+atlas serve [flags]
+```
+
+#### Details
+'atlas serve' runs the Atlas web UI in a standalone mode with optional persistent storage.
+If you do not specify the storage, it will be stored in-memory.
+Atlas encrypts sensitive data such as passwords using the generated keyset.json.
+
+#### Flags
+```
+--addr string       listen address for atlas serve (default ":8080")
+--storage string    data store url using the dsn format:
+                    [driver://username:password@protocol(address)/dbname?param=value] (default "in-memory")
+-h, --help          help for serve
+```
+
 {{ end }}
diff --git a/doc/md/cli/reference.md b/doc/md/cli/reference.md
@@ -195,3 +195,25 @@ atlas version
 ```
 
 
+## atlas serve
+
+Run Atlas web UI in a standalone mode
+
+#### Usage
+```
+atlas serve [flags]
+```
+
+#### Details
+'atlas serve' runs the Atlas web UI in a standalone mode with optional persistent storage.
+If you do not specify the storage, it will be stored in-memory.
+Atlas encrypts sensitive data such as passwords using the generated keyset.json.
+
+#### Flags
+```
+--addr string       listen address for atlas serve (default ":8080")
+--storage string    data store url using the dsn format:
+                    [driver://username:password@protocol(address)/dbname?param=value] (default "in-memory")
+-h, --help          help for serve
+```
+
diff --git a/doc/package-lock.json b/doc/package-lock.json