Skip to content
plywoodDocs

Add plywood to a repo

llms.txtlists every page for an agent
Terminal window
npm i -D @intentius/plywood


npx plywood init

init does five things:

  1. Finds each Pulumi.yaml and lists its stacks from the Pulumi.<stack>.yaml files beside it.
  2. Writes plywood.yml with only the settings it could not read from the repository. A plywood.yml already there is kept as it is.
  3. Writes the waves a merge updates in to .chant/op-waves/pulumi-up.spec.json: one wave per environment, the first wave the canary.
  4. Renders the pipeline for the forge your origin remote names: .github/workflows/plywood.yml, .gitlab-ci.yml or .forgejo/workflows/plywood.yml, and the wave jobs beside it.
  5. Prints the secrets and settings left for you to add.

It also writes chant.workspace.json, chant.config.ts, plywood.component.ts and ops/pulumi-up.op.ts, which chant reads. The last is the pulumi-up Op the waves run under; run by hand with npx chant run pulumi-up, it previews each stack in wave order. Commit them with the rest.

The pipeline is chant’s pull request CI with plywood’s words on its notes, statuses and comments.

Options

Section titled “Options”
Flag Effect
--preset merge|before-merge|approve-all when updates run and when a wave waits; merge when left out
--gate always|on-destructive|never when a wave waits for an approval
--engine pulumi|plunge the engine the stacks run; init picks plunge only with this flag
--from <source>[=<file>] read pulumi-actions, deployments, spacelift or env0 settings from the repository, or from the files named
--forge github|gitlab|forgejo the forge, when origin does not say
--dry-run print the files init would write, and write none

Per forge

Section titled “Per forge”
Forge Pipeline file Status
GitHub .github/workflows/plywood.yml plywood/preview check
GitLab .gitlab-ci.yml plywood/preview external status
Forgejo .forgejo/workflows/plywood.yml plywood/preview commit status

Make plywood/preview a required status on the default branch. plywood.yml lists every key.

Optional: hand this page to your coding agentThe steps work by hand too.
Set up plywood in this repository.
Read https://intentius.io/plywood/llms.txt first, then
https://intentius.io/plywood/getting-started/agents/ and follow it.
Ask me which stacks should wait for an approval before they update.
Open a pull request with the result.
Never run `pulumi up`, `plunge up`, `pulumi destroy` or `plywood approve`, override a policy denial, use `--mode up`, or merge; never touch `.chant/allowed_signers` or `chant/lifecycle`.

plywood