Upstream/LuckPerms
1
0
Fork 0
mirror of https://github.com/LuckPerms/LuckPerms.git synced 2024-11-25 03:55:32 +01:00
Code Issues Projects Releases Wiki Activity

Add the --merge and --upload types to general commands page (#73)

Larry 2020-07-21 15:53:23 -06:00 committed by Luck
parent c1581bd13e
commit 70f997f09c
No known key found for this signature in database
GPG Key ID: EFA9B3EC5FD90F8B
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Command-Usage:-General.md

@ -21,8 +21,8 @@ ___
* [/lp `search` \<permission\>](#lp-search-permission) * [/lp `search` \<permission\>](#lp-search-permission)
* [/lp `check` \<user\> \<permission\>](#lp-check-user-permission) * [/lp `check` \<user\> \<permission\>](#lp-check-user-permission)
* [/lp `networksync`](#lp-networksync) * [/lp `networksync`](#lp-networksync)
* [/lp `import` \<file\>](#lp-import-file) * [/lp `import` \<file | code --upload\> [--merge]](#lp-import-filecode---upload---merge)
* [/lp `export` \<file\>](#lp-export-file) * [/lp `export` \<file\> [--upload]](#lp-export-file--upload)
* [/lp `reloadconfig`](#lp-reloadconfig) * [/lp `reloadconfig`](#lp-reloadconfig)
* [/lp `bulkupdate`](#lp-bulkupdate-data-type-action-action-field-action-value-constraints) * [/lp `bulkupdate`](#lp-bulkupdate-data-type-action-action-field-action-value-constraints)
* [/lp `migration`](#lp-migration-plugin-name-options) * [/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. 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 <file>` #### `/lp import <file|code --upload> [--merge]`
**Permission**: luckperms.import **Permission**: luckperms.import
**Arguments**: **Arguments**:
* `<file>` - the file to import from * `<file>` - the file to import from
* `<code> --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 <file>` #### `/lp export <file|--upload>`
**Permission**: luckperms.export **Permission**: luckperms.export
**Arguments**: **Arguments**:
* `<file>` - the file to export to * `<file>` - 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` #### `/lp reloadconfig`