feat(docs): added Backup documentation
Some checks failed
Actions / Lint Code (Pylint) (pull_request) Failing after 17s
Actions / Build Documentation (MkDocs) (pull_request) Successful in 13s

This commit is contained in:
Seaswimmer 2024-01-31 12:31:37 -05:00
parent 7fa6cd5922
commit 6fbfa96cf2
Signed by: cswimr
GPG key ID: B8953EC01E5C4063
2 changed files with 27 additions and 0 deletions

25
.docs/backup.md Normal file
View file

@ -0,0 +1,25 @@
# Backup
Backup allows you to export a JSON list of all of your installed repositories and cogs, then reimport them and automatically reinstall/reload the cogs.
## Installation
```bash
[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
[p]cog install seacogs backup
[p]cog load backup
```
## Commands
#### backup export
- Usage: `[p]backup export`
Exports a JSON list of all of your added repositories, and their installed cogs.
#### backup import
- Usage: `[p]backup import [json]`
Imports, reinstalls, and reloads cogs from a valid export. Requires either the json export to be provided in the command's message content or to be attached to the command's message. Ignores itself and PyLav cogs.

View file

@ -16,6 +16,7 @@ nav:
- Moderation Commands: aurora/moderation-commands.md
- Case Commands: aurora/case-commands.md
- Configuration: aurora/configuration.md
- Backup: backup.md
- Nerdify: nerdify.md
plugins:
@ -100,4 +101,5 @@ theme:
watch:
- ./aurora
- ./backup
- ./nerdify