yield/Documentation

Reference / CLI

Build the workflow manually. Accelerate it optionally.

The CLI creates, tests, registers, and runs coded skills. The developer helper is an explicit extra installation, never a package side effect.

01 / Manual

Use five commands for the normal lifecycle.

TypeScript launcher
npm exec -- yskill init skills/release --language typescript \
  --description "Test, review, approve, publish, and verify a package."
# Edit the workflow code and fixtures/responses.json.
npm exec -- yskill doctor skills/release --test
npm exec -- yskill register skills/release
# Restart the coding agent.
npm exec -- yskill run skills/release
init

Create one canonical workflow and deterministic fixture files.

doctor --test

Run the fixture to a terminal outcome without keeping a journal.

register

Write small discovery adapters for selected coding agents.

run

Start a saved workflow run and return its first operation.

02 / Optional

Install the developer helper explicitly.

Package installation creates no skill or adapter. Choose the command for the package already used by your repository.

TypeScript

npm
npm exec -- yskill helper install --language typescript

Python

python
python -m yieldskill helper install --language python

Go

go run
go run github.com/operatorstack/yield/cmd/yskill@latest helper install --root . --language go

Rust

cargo + .yield/bin
cargo install yieldskill --root .yield --locked
.yield/bin/yskill helper install --root . --language rust

Restart the coding agent after installation so it discovers skills/yield-workflow-builder.

Installer options
yskill helper install
  [--language typescript|python|rust|go]
  [--agent auto|cursor,codex,claude-code]
  [--root repository]
  [--dry-run]
  [--yes]
03 / Modes

Ask the helper for one bounded job.

learn

Teach the relevant primitive and manual path. Read-only.

create

Create a tested workflow in a new destination.

convert

Convert one existing skill directory while preserving guidance.

check

Run static doctor checks without fixtures or writes. Read-only.

repair

Plan from doctor evidence, repair, and verify.

upgrade

Move one workflow to the installed Yield version.

register

Test, register selected agents, and verify adapters.

Example requests after restart

Use Yield to explain how coded skill workflows work.
Use Yield to create a tested skill workflow for releasing my package.
Use Yield to convert skills/release into a tested skill workflow.
04 / Approval

See every mutation before it runs.

The installer previews resolved paths, dependency preparation, workflow testing, selected-agent registration, and final adapter verification. Changing modes then show the relevant primitives and exact mutations.

Summary
Primitives
Files
Commands

Apply this plan?
  • learn and check remain read-only.
  • Failed verification permits at most two repair attempts.
  • Path escapes, existing destinations, ownership conflicts, and unsupported versions are refused.
  • The helper cannot upgrade itself during an active run.
  • Successful changes require workflow tests, registration, and adapter verification.
Compatibility only.yskill bootstrap and npm create @operatorstack/yield@latest call the same installer, but new usage should say yskill helper install.