Skip to content
Workstate

init

The init command prepares your project folder to be tracked by Workstate by creating the necessary configuration files.

Usage

Section titled “Usage”
Terminal window
workstate init

How it works

Section titled “How it works”
  1. Creates .workstateinclude: Generates a whitelist file in your root directory. Only files and patterns listed here will be captured by the save command.
  2. Populates Defaults: Automatically adds sensible defaults to the include file (e.g., src/, README.md, pyproject.toml).
  3. Auto-detection: Attempts to detect your project stack (Python, Node, etc.) to tailor the environment setup.

Examples

Section titled “Examples”
Terminal window
cd my-project
workstate init