User guide overview

This manual is for PeppyKeep users and is organized according to the “Prerequisite → Profile → Platform Installation → Function Block Operation”, which corresponds to the backup, recovery, cleaning, encryption, object storage and other capabilities in the product profile design.

reading order

1. Prerequisites — Installation, permissions and default configuration directory
2. Profile — Install auto-generated app.toml, bak.toml, prj.toml and bulk MySQL request files that need to be created manually
3. Choose Platform
   • Windows — Installation and function blocks
   • macOS and Linux Command Line Features Guide — Shared command line installation and function blocks

Platform Support Boundaries

The PeppyKeep command line is supported on Windows, macOS, and Linux. Desktop is in development and plans to only support Windows and macOS; Linux does not provide desktop, but can be invoked or managed by Windows or macOS desktop.

Relationship to Command Reference

The function block document focuses on the complete steps of “Configure by Scene + Preview + Execute”; for details of the parameters of each command, see Command Reference.

Reference configuration

The sample manual aligns the generated configuration directory by default after installation:

• macOS / Linux：~/.peppykeep/conf
• Windows：%USERPROFILE%\.peppykeep\conf

Wherein prj_key = test_717_file, data_dir and bak.toml in the path, encryption, object storage and other fields are consistent with the current test environment.