SeaCogs/.docs/backup.md

# 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

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

## Version Compatibility

As of commit [1edb08a](https://www.coastalcommits.com/cswimr/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.
feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00			`# Backup`

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 19:30:42 -04:00			`Backup allows you to export a JSON list of all of your installed repositories and cogs, then reimport them and automatically reinstall the cogs.`
feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00
			`## Installation`

			```bash
fix(repo): update all instances of SeaswimmerTheFsh to cswimr 2024-08-27 14:25:14 -04:00			`[p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs`
fix(repo/docs): changed name back to seacogs/SeaCogs 2024-02-01 23:08:34 -05:00			`[p]cog install seacogs backup`
feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00			`[p]cog load backup`
			```

docs(backup): updated docs with a disclaimer about version compatibility 2024-03-29 03:31:00 -04:00			`## Version Compatibility`

fix(repo): update all instances of SeaswimmerTheFsh to cswimr 2024-08-27 14:25:14 -04:00			As of commit [1edb08a](https://www.coastalcommits.com/cswimr/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`.
docs(backup): updated docs with a disclaimer about version compatibility 2024-03-29 03:31:00 -04:00
			```bash
			`[p]cog installversion sea-cogs 43464db6a7c51bc69282b1ae3dc507a4aae851de backup`
			```

feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00			`## Commands`

fix(docs): fixed incorrect headers 2024-01-31 12:34:26 -05:00			`### backup export`
feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00
			- Usage: `[p]backup export`

			`Exports a JSON list of all of your added repositories, and their installed cogs.`

fix(docs): fixed incorrect headers 2024-01-31 12:34:26 -05:00			`### backup import`
feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00
fix(backup): doing some cleanup 2024-01-31 15:48:23 -05:00			- Usage: `[p]backup import`
feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00
fix(backup): doing some cleanup 2024-01-31 15:48:23 -05:00			`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.`