Skip to content
Browse documentation

Getting started with Etch

Create a consumer repository, review your first plan, and apply one Git module.

EtchGetting started

Create your own repository from the Etch template, then clone that repository with git clone --recurse-submodules. The template pins the engine and includes one generic Git configuration module. It contains no personal identity.

Review before applying

From your consumer repository, run:

./etch
./etch doctor --profile developer

Bare ./etch displays the developer plan. It does not apply changes. Review modules/git/files/gitconfig and any existing home configuration before proceeding. A conflicting existing file is refused rather than silently replaced.

./etch apply --profile developer

A second apply skips declarative state that is already satisfied. Opaque commands can still report execution; inspect their behavior separately.

Keep ownership explicit

Edit modules, profiles, and defaults in your consumer repository. Update its engine pin deliberately. After initialization, Etch requires Python 3.9 or newer; there is no runtime pip installation. Individual providers may require external tools.

The template README explains submodule initialization, CI checks, and updating the engine.

Next steps

Read modules and profiles, then the user guide. The CLI reference explains selection and output options. For Windows, review the supported launcher, paths and privilege rules before using a POSIX consumer template. Use updates and submodules when maintaining an initialized checkout; updating does not apply configuration.