CLI reference

heddle init

Shipped

heddle init [OPTIONS] [PATH]

Initialize Heddle in a directory or existing Git checkout

Output text (default) · json

Arguments

[PATH] value optional: Directory to initialize (default: current directory)

Flags

--principal-name <PRINCIPAL_NAME>: Principal name for attribution
--principal-email <PRINCIPAL_EMAIL>: Principal email for attribution
--install-harnesses <INSTALL_HARNESSES>: Install harness integrations after init
--no-harness-install <NO_HARNESS_INSTALL>: Skip harness integration installation during init values: true · false
--harness-install-scope <HARNESS_INSTALL_SCOPE>, --scope: Preferred install scope (`repo` or `user`) default: repo
--harness-install-force <HARNESS_INSTALL_FORCE>: Overwrite Heddle-managed integration entries when needed values: true · false
--op-id <OP_ID> hidden: Operation id (UUID v4) for idempotent retries. See `heddle help operation-ids` Accepted by the CLI, but absent from standard --help.

Exit codes

Declared by this command's contract, verbatim. Anything not listed contracts only to 0 on success and an unspecified non-zero on failure. The full table and the retry rule — in short, 75 is the only code that is safe to retry.

0: ok
73: cannot create state directory
78: workspace config invalid

Examples

initialize here; existing Git becomes Git Overlay

bash$ heddle init

initialize a native Heddle subdirectory

bash$ heddle init my-project

Example

bash$ heddle init --principal-name 'Ada Lovelace' --principal-email ada@example.com