muddle/docs/install.md

Install Muddle from Forgejo

Install the framework directly from the Muddle Forgejo repository.

bun add muddle@git+https://git.crit.rip/mdl/muddle.git

npm install muddle@git+https://git.crit.rip/mdl/muddle.git

Integrations are isolated @muddle/* modules. After their Forgejo repositories are provisioned, install one independently.

bun add @muddle/shadcn@git+https://git.crit.rip/mdl/shadcn.git

Create a Forgejo personal access token with repository creation rights, then provision the namespace repositories. The script only reads MUDDLE_FORGEJO_TOKEN from the environment and never prints it.

MUDDLE_FORGEJO_TOKEN=token bun scripts/forgejo-modules.ts

Preview without network writes.

bun scripts/forgejo-modules.ts --dry-run

To commit changed integration module directories with generic chore: update @muddle/<name> integration messages and push their subtree history, preview the operation first. Unchanged modules are also synced so newly created Forgejo repositories receive their initial branch.

bun scripts/forgejo-push.ts

Push only after review. This requires the same token and creates local commits.

MUDDLE_FORGEJO_TOKEN=token bun scripts/forgejo-push.ts --push