SeaCogs/.docs/backup.md
SeaswimmerTheFsh 76da85365c
Some checks failed
Actions / Lint Code (Ruff & Pylint) (push) Successful in 43s
Actions / Build Documentation (MkDocs) (push) Failing after 25s
docs(backup): updated docs with a disclaimer about version compatibility
2024-03-29 03:31:00 -04:00

33 lines
1.2 KiB
Markdown

# 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://www.coastalcommits.com/SeaswimmerTheFsh/SeaCogs
[p]cog install seacogs backup
[p]cog load backup
```
## Version Compatibility
As of commit [1edb08a](https://www.coastalcommits.com/SeaswimmerTheFsh/SeaCogs/commit/1edb08a1271f12098ca0bed11a735f7162cedd14), 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`.
```bash
[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.