Skip to content

Commands Overview

Workstate provides a powerful CLI to manage your environment states. Here is a summary of all commands.

CommandDescription
configureSetup AWS credentials and S3 bucket.
initInitialize Workstate tracking in the current directory.
statusShow differences between local state and S3.
saveCapture and upload the current environment state.
listList available backups on S3.
downloadRestore a state from S3 to your machine.
syncAutomatically sync with the latest backup.
compareCompare local state against a specific backup.
inspectView detailed metadata of a specific backup.
protectLock a backup to prevent accidental deletion.
deleteRemove backups from S3.
git-hookInstall or remove Git integration hooks.
doctorCheck health and connectivity of your setup.
updateUpdate Workstate to the latest version.

Each command has a dedicated page with detailed options and examples. Explore them in the Commands section of the sidebar.