From 70f997f09cdfcb3a28eb6c4a28e94010da6ebf65 Mon Sep 17 00:00:00 2001 From: Larry Date: Tue, 21 Jul 2020 15:53:23 -0600 Subject: [PATCH] Add the --merge and --upload types to general commands page (#73) --- Command-Usage:-General.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/Command-Usage:-General.md b/Command-Usage:-General.md index be8cf8d..d908176 100644 --- a/Command-Usage:-General.md +++ b/Command-Usage:-General.md @@ -21,8 +21,8 @@ ___ * [/lp `search` \](#lp-search-permission) * [/lp `check` \ \](#lp-check-user-permission) * [/lp `networksync`](#lp-networksync) -* [/lp `import` \](#lp-import-file) -* [/lp `export` \](#lp-export-file) +* [/lp `import` \ [--merge]](#lp-import-filecode---upload---merge) +* [/lp `export` \ [--upload]](#lp-export-file--upload) * [/lp `reloadconfig`](#lp-reloadconfig) * [/lp `bulkupdate`](#lp-bulkupdate-data-type-action-action-field-action-value-constraints) * [/lp `migration`](#lp-migration-plugin-name-options) @@ -119,20 +119,24 @@ ___ Refreshes all cached data with the storage provider, and then uses the plugins Messaging Service (if configured) to "ping" all other connected servers and request that they sync too. ___ -#### `/lp import ` +#### `/lp import [--merge]` **Permission**: luckperms.import **Arguments**: * `` - the file to import from +* ` --upload` - the code to web-import from +* `[--merge]` - if included, will merge the import with existing permissions. If not, will overwrite. -Imports data into LuckPerms from a file. The file must be a list of commands, starting with "/luckperms". This file can be generated using the export command. The file is expected to be in the plugin directory. + +Imports data into LuckPerms from a file or from the web. If a file, it must be a JSON GZIP type file, exported from Luckperms v5. If from the web, the code must be generated when exporting with the `--upload` flag. The file is expected to be in the plugin directory. When importing a file, the extension `.json.gz` should be included in the name of the import file. When importing a file or web-export, the `--merge` flag may be added to the end of the command to merge the import with the existing permissions setup. If the `--merge` flag is not included, the existing permissions setup will be overriden and replaced. ___ -#### `/lp export ` +#### `/lp export ` **Permission**: luckperms.export **Arguments**: * `` - the file to export to +* `<--upload>` - if added, will export to the web and provide a code for web-based imports. -Exports data from LuckPerms into a file. This file can either be used as a backup, or used to move data between LuckPerms installations. The file can be re-imported using the import command. The generated file will be in the plugin directory. +Exports data from LuckPerms into a file or into web-based datastorage. This file can either be used as a backup, or used to move data between LuckPerms installations. The web-based export will expire and should not be used as a backup. The file and the web-based export can be re-imported using the import command. The generated file will be in the plugin directory. ___ #### `/lp reloadconfig` @@ -202,4 +206,4 @@ ___ **Permission**: luckperms.listtracks Displays a list of all current tracks. -___ \ No newline at end of file +___