Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

factory-starter

factory-starter is the forkable home for one Factory instance. It keeps your organization's repository routing, policies, schedules, and optional packs separate from the Factory kernel.

Start an instance

  1. Create a repository from this template and replace the example values in config/ with your organization and repositories.

  2. Validate the copied scaffold before configuring credentials or schedules:

    bun run check
  3. Review the exact published kernel version in package.json, then install it from npm:

    bun install
  4. Keep every schedule disabled while you verify repository credentials, worktree scripts, and the proposed workflow.

The committed kernel reference is deliberately an exact npm version, without a ^ or ~ range. Upgrades are an explicit dependency change: review the Factory release, update package.json, run bun install, then run this instance's checks before merging.

What belongs here

  • config/repos.yaml — this instance's repository registry and worktree facts
  • config/policy.yaml — this instance's autonomy and safety policy
  • config/schedule.yaml — disabled-by-default schedule declarations
  • packs/ — optional, namespaced data-only extensions for this instance

Do not edit the installed node_modules/@watt-mind/factory tree. If a feature should benefit every instance, propose it upstream; see the kernel's docs/instances.md.