Command Line Reference

Reference

init

Initialize an Overplane project in the current directory (or --dir). Creates overplane.yaml from schema defaults if missing, validates it strictly against the embedded schema, ensures overplane.yaml is not listed in .gitignore, and verifies the working directory is writable. Optional flags override project name, description, and directory paths when the file is first created. Idempotent and non-destructive: re-running validates without changing any byte on disk except removing an overplane.yaml .gitignore entry when present.

Optional

Directory to initialize instead of the current directory.

Project name written to overplane.yaml when the file is created (default: derived from the directory name).

Project description written to overplane.yaml when the file is created.

Cache directory path written to overplane.yaml when the file is created.

Specs directory path written to overplane.yaml when the file is created.

Usage

# Usage
overplane init [--dir PATH] [--name NAME] [--description DESC] [--cache_dir DIR] [--specs_dir DIR]

# Examples
# Initialize the current directory as an Overplane project.
$ overplane init
# Initialize a specific directory.
$ overplane init --dir ./myproject
# Initialize with a custom project name and description.
$ overplane init --name my-app --description "My app."