SeaCogs/.docs/backup.md
Seaswimmer ff68d6ea19
All checks were successful
Actions / Build Documentation (MkDocs) (push) Successful in 26s
Actions / Lint Code (Ruff & Pylint) (push) Successful in 38s
docs(backup): removed reload from the backup docs
due to some techincal limitations, the `backup` cog does not actually reload cogs it reinstalls. the end user still has to do that, this is because there's no good way for `backup` to confirm if a cog is loaded or not whenever exporting the list of repos/cogs.

Signed-off-by: Seaswimmer <seaswimmerthefsh@gmail.com>
2024-07-11 23:30:42 +00:00

1.1 KiB

Backup

Backup allows you to export a JSON list of all of your installed repositories and cogs, then reimport them and automatically reinstall the cogs.

Installation

[p]repo add seacogs https://www.coastalcommits.com/SeaswimmerTheFsh/SeaCogs
[p]cog install seacogs backup
[p]cog load backup

Version Compatibility

As of commit 1edb08a, the Backup cog no longer supports Red versions older than 3.5.6. If you want to use the cog on an earlier version (3.5.0 - 3.5.5), install the cog pinned to this commit: 43464db6a7c51bc69282b1ae3dc507a4aae851de.

[p]cog installversion sea-cogs 43464db6a7c51bc69282b1ae3dc507a4aae851de 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

Reinstalls repositories and cogs from a valid export. Requires the JSON export to be attached to the invoking message as an attachment. Ignores itself and PyLav cogs, due to possible conflicts with Docker images.