macOS and Linux Command Line Features Guide
This page and its function blocks are for command line use on macOS and Linux. Both systems use the same PeppyKeep commands, parameters, and default configuration directory; only the installation environment and a few system path differences are noted.
The desktop is under development, and the plan is to support Windows and macOS only, not Linux. Linux hosts are available only from the command line, but can be invoked or managed from the Windows or macOS desktop.
Configure Folders
After install, ~/.peppykeep/conf gets app.toml, bak.toml, and prj.toml. Before the first backup, confirm they exist and match your environment (MySQL, paths, object storage). Bulk MySQL jobs also need mysql_bak_request.toml.
Field reference: Configuration files (app.toml, bak.toml, prj.toml, etc.). Use --config-home or env var PPK for the config directory.
Quick Start (Basic Application Data Backup)
# 1. Confirm that the download and installation have been completed on the official website
# 2. Confirm that app.toml, bak.toml, prj.toml already exist under ~/.peppykeep/conf, and modify by environment (such as data_dir of prj.toml)
# 3. Prepare Test Data
mkdir -p /tmp/test_file_717 && echo "sample" > /tmp/test_file_717/sample.txt
# 4. Pre-inspection
peppykeep backup run --config-home ~/.peppykeep/conf --bak-type app-data
# 5. Formal backup (local + upload, configured by bak.toml)
peppykeep backup run --apply --config-home ~/.peppykeep/conf --bak-type app-data
’–no-upload` can only be added when backing up locally.
Download & Install
Go to the PeppyKeep official website download page to download and install
Function elements
Follow the scenario step by step, each section contains configuration points, dry-run and formal execution (--apply):
Configuration Specification (CS)
The following files are automatically generated in the default configuration directory during installation. Please confirm that the files exist before modifying them: