Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Workler

Workler creates full, isolated Git clones under .worktrees/. Each workspace has its own repository state, with optional copy and link rules for sharing local dependencies or copying untracked configuration.

Documentation · Getting started · CLI reference · API reference

Install

Workler requires Node.js 18 or newer and Git.

npm install -g workler
workler help

Quick start

Create and enter a workspace from any Git repository—no initialization or configuration file is required:

workler add feature-a
cd "$(workler path feature-a)"

This creates .worktrees/feature-a as an independent clone and checks out a new feature-a branch.

If a workspace needs local files, add an optional .workler file before creating it:

link node_modules
copy .env

workler init can create a commented starter file, but it is not required. Apply new rules to an existing workspace with workler apply feature-a.

Useful commands:

workler list                 # list workspaces
workler status               # show branch and working-tree state
workler sync                 # safely fast-forward workspaces
workler remove feature-a     # remove a workspace

See the CLI reference for every command and option.

Highlights

  • Independent clones — unlike git worktree, each workspace has its own Git metadata, branches, and fetch state.
  • Repeatable setupcopy and link rules prepare local dependencies and untracked files automatically.
  • Safe by default — existing data is not overwritten without --force, and --dry-run previews changes.
  • Workspace coordinationstatus and sync commands operate across all local clones without merging or rebasing.
  • Nested workflowsnested workspaces support parallel features and coding agents.
  • Programmatic use — the package includes a typed JavaScript and TypeScript API.

Development

npm install
npm run check
npm test
npm run docs:dev

License

MIT

Releases

Packages

Used by

Contributors

Languages