Skip to content

agent-setup.md

Latest commit

 

History

History
93 lines (72 loc) · 3.89 KB

agent-setup.md

File metadata and controls

93 lines (72 loc) · 3.89 KB
Raw

Run one skill workflow from your coding agents

The canonical skill workflow belongs beside the application and language dependencies it uses. yskill register creates only the small SKILL.md adapters required for agent discovery.

Register an existing skill workflow

# Detect installed verified agents
yskill register skills/review

# Or choose agents explicitly
yskill register skills/review --agent cursor,codex,claude-code

# Check the workflow itself
yskill doctor skills/review --test

# Check selected adapters too
yskill doctor skills/review --agent cursor,codex,claude-code --test

# Register a complete workflow directory in one pass
yskill register-all skills --agent cursor,codex,claude-code --dry-run
yskill register-all skills --agent cursor,codex,claude-code --prune

Use the launcher installed by the selected language package:

Language Launcher
TypeScript npm exec -- yskill
Python python -m yieldskill
Go .yield/bin/yskill
Rust .yield/bin/yskill

Go and Rust keep one version-locked runtime in .yield/bin at the repository root. Registration checks that runtime, the workflow SDK, and the generated adapter all use the same Yield version. It refuses a missing or mismatched runtime and prints the exact repair command. A global yskill is not used. Windows adapters use .\.yield\bin\yskill.exe.

Run yskill agents to see every supported ID and project directory. Cursor, Codex, and Claude Code are verified. Other entries use paths from a pinned snapshot of the open vercel-labs/skills registry and are labelled registry: path generation is tested, but the product itself has not been run end to end by Yield.

Generated adapters are safe to commit. They are disposable discovery files, not copies of the workflow. Regenerate them after changing the canonical skill workflow. Yield refuses to overwrite a user-owned skill with the same name. Names must also be unique across languages because coding agents use one project-level skill namespace.

Copy this to your agent

Replace the bracketed values, then paste this into the coding agent already open in the project:

Set up a Yield skill workflow named [skill-name] in skills/[skill-name].

1. Detect whether this project uses TypeScript, Python, Go, or Rust.
2. Install that language's Yield package using the project's existing package
   manager. Do not install a second global runtime.
3. Run yskill init with the detected language and this description:
   [what the workflow does and when it should run]
4. Replace the starter program and fixture with the requested skill workflow. The
   starter is intentionally blocked and must not pass tests unchanged.
5. Run yskill doctor with --test before registration.
6. Keep the canonical workflow beside the project's language dependencies.
7. Run yskill register for the coding agent you are currently using.
8. Use the launcher from the installed language package for every yskill
   command: npm exec -- yskill, python -m yieldskill, or .yield/bin/yskill.
9. Run yskill doctor with --agent and --test.
10. Report the commands, generated adapter path, and every changed file.

Do not move the skill workflow into an agent discovery directory and do not copy its
dependencies into an adapter.

## Questions and agent results

The skill workflow emits a typed operation. The coding agent may show that operation using
its native question UI. Yield does not render the UI. After collecting an
answer, the adapter uses `yskill respond`; it does not create `response.json`.

Use `--value` for a person’s answer and `--result-json` for structured agent
work. The file-based `resume --response` command remains available for CI.

Workflow-only `doctor` works without `.git`. A Go or Rust runtime under
`.yield/bin` also identifies the project root for `init`, `doctor`, and
registration. For other non-Git layouts, pass `--root` so Yield knows where
agent adapters belong.