Synchronize CLI documentation from mittwald/cli

mittwald · Sep 17, 2024 · 1bad625 · 1bad625
1 parent 09b5db2
commit 1bad625
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 14 deletions.
diff --git a/docs/cli/reference/app.md b/docs/cli/reference/app.md
@@ -345,18 +345,19 @@ Download the filesystem of an app within a project to your local machine
 ```
 USAGE
   $ mw app download [INSTALLATION-ID] --target <value> [-q] [--ssh-user <value>] [--ssh-identity-file <value>]
-    [--exclude <value>...] [--dry-run] [--delete]
+    [--exclude <value>...] [--dry-run] [--delete] [--remote-sub-directory <value>]
 
 ARGUMENTS
   INSTALLATION-ID  ID or short ID of an app installation; this argument is optional if a default app installation is set
                    in the context.
 
 FLAGS
-  -q, --quiet               suppress process output and only display a machine-readable summary.
-      --delete              delete local files that are not present on the server
-      --dry-run             do not actually download the app installation
-      --exclude=<value>...  [default: ] exclude files matching the given pattern
-      --target=<value>      (required) target directory to download the app installation to
+  -q, --quiet                         suppress process output and only display a machine-readable summary.
+      --delete                        delete local files that are not present on the server
+      --dry-run                       do not actually download the app installation
+      --exclude=<value>...            [default: ] exclude files matching the given pattern
+      --remote-sub-directory=<value>  specify a sub-directory within the app installation to download
+      --target=<value>                (required) target directory to download the app installation to
 
 SSH CONNECTION FLAGS
   --ssh-identity-file=<value>  the SSH identity file (private key) to use for public key authentication.
@@ -381,12 +382,28 @@ DESCRIPTION
   rsync. Have a look at https://manpages.ubuntu.com/manpages/noble/en/man1/rsync.1.html#filter%20rules for more
   information on how to write filter rules.
 
+EXAMPLES
+  Download entire app to current working directory
+
+    $ mw app download .
+
+  Download only shared dir from a deployer-managed app
+
+    $ mw app download --remote-sub-directory=shared .
+
 FLAG DESCRIPTIONS
   -q, --quiet  suppress process output and only display a machine-readable summary.
 
     This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
     scripts), you can use this flag to easily get the IDs of created resources for further processing.
 
+  --remote-sub-directory=<value>  specify a sub-directory within the app installation to download
+
+    This is particularly useful when you only want to download a specific sub-directory of the app installation, for
+    example when you are using a deployment tool that manages the app installation directory itself, and you only want
+    to download exempt files, like environment specific configuration files or user data. For example, if you want to
+    download from "/html/my-app-XXXXX/config", set "--remote-sub-directory=config".
+
   --ssh-identity-file=<value>  the SSH identity file (private key) to use for public key authentication.
 
     The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
@@ -1989,18 +2006,19 @@ Upload the filesystem of an app to a project
 ```
 USAGE
   $ mw app upload [INSTALLATION-ID] --source <value> [-q] [--ssh-user <value>] [--ssh-identity-file <value>]
-    [--exclude <value>...] [--dry-run] [--delete]
+    [--exclude <value>...] [--dry-run] [--delete] [--remote-sub-directory <value>]
 
 ARGUMENTS
   INSTALLATION-ID  ID or short ID of an app installation; this argument is optional if a default app installation is set
                    in the context.
 
 FLAGS
-  -q, --quiet               suppress process output and only display a machine-readable summary.
-      --delete              delete remote files that are not present locally
-      --dry-run             do not actually upload the app installation
-      --exclude=<value>...  [default: ] exclude files matching the given pattern
-      --source=<value>      (required) source directory from which to upload the app installation
+  -q, --quiet                         suppress process output and only display a machine-readable summary.
+      --delete                        delete remote files that are not present locally
+      --dry-run                       do not actually upload the app installation
+      --exclude=<value>...            [default: ] exclude files matching the given pattern
+      --remote-sub-directory=<value>  specify a sub-directory within the app installation to upload
+      --source=<value>                (required) source directory from which to upload the app installation
 
 SSH CONNECTION FLAGS
   --ssh-identity-file=<value>  the SSH identity file (private key) to use for public key authentication.
@@ -2034,6 +2052,13 @@ FLAG DESCRIPTIONS
     This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
     scripts), you can use this flag to easily get the IDs of created resources for further processing.
 
+  --remote-sub-directory=<value>  specify a sub-directory within the app installation to upload
+
+    This is particularly useful when you only want to upload a specific sub-directory of the app installation, for
+    example when you are using a deployment tool that manages the app installation directory itself, and you only want
+    to upload exempt files, like environment specific configuration files or user data. For example, if you want to
+    upload to "/html/my-app-XXXXX/config", set "--remote-sub-directory=config".
+
   --ssh-identity-file=<value>  the SSH identity file (private key) to use for public key authentication.
 
     The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to

diff --git a/docs/cli/reference/autocomplete.md b/docs/cli/reference/autocomplete.md
@@ -34,4 +34,4 @@ EXAMPLES
   $ mw autocomplete --refresh-cache
 ```
 
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.3/src/commands/autocomplete/index.ts)_
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.4/src/commands/autocomplete/index.ts)_
diff --git a/docs/cli/reference/update.md b/docs/cli/reference/update.md
@@ -40,4 +40,4 @@ EXAMPLES
     $ mw update --available
 ```
 
-_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.5.6/src/commands/update.ts)_
+_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.5.7/src/commands/update.ts)_