]> BookStack Code Mirror - website/blobdiff - content/docs/admin/system-cli.md
Updated CLI docs to document download-vendor command
[website] / content / docs / admin / system-cli.md
index 60fdb3e4baed1a170cbafc1dce746cf519ecc659..39a11baee762a55c3d199027ca6c01c691dbf593 100644 (file)
@@ -155,6 +155,26 @@ Note that this won't do everything for a new BookStack install, you'll still nee
 ./bookstack-system-cli init /var/www/new-bookstack
 ```
 
+#### download-vendor
+
+Download `vendor/` files for a BookStack instance. This will download a relevant version ZIP from
+https://files.bookstackapp.com/vendor/ and extract its contents to a `vendor/` directory within the specified
+(or current) BookStack instance.
+The downloaded ZIP is validated against a checksum found in the BookStack instance.
+
+This is intended to replace the `composer install --no-dev` update step, and therefore reduces reliance on downloading required dependencies from multiple external sources (GitHub, Codeberg, etc...).
+
+##### Usage Examples
+
+```bash
+# Download vendor files to the current BookStack instance
+./bookstack-system-cli download-vendor
+```
+
+##### Command Options
+
+- `--app-directory=<path>` Provide a path to the BookStack instance to back up. When not provided, the CLI will attempt to locate the BookStack install based upon current working directory and the location of the CLI itself.
+
 ---
 
 ### CLI Source Code & Project