Skip to content

workler init

Set up the current project for Workler.

bash
workler init

Behavior

Run in the project root (anywhere inside the repository works — the git top level is used):

  1. Creates a starter .workler file with commented syntax examples — kept as-is if it already exists.
  2. Creates the .worktrees/ directory.
  3. Excludes .worktrees/ from git via .git/info/exclude — local to your machine, so your committed .gitignore is untouched.
  4. Records the project as a workler root (git config workler.root and workler.name main).

Outside a git repository, the exclude line goes to .gitignore instead, with a warning.

init is idempotent — run it as often as you like.

Output

text
created .workler
ready   .worktrees
ignored .worktrees/ in .git/info/exclude

On a second run, created becomes exists.

Examples

bash
cd my-project
workler init
echo "link node_modules" >> .workler
echo "copy .env" >> .workler
workler add feature-a

Released under the MIT License.