Skip to content

Document tongs setup in the README#16

Merged
CrypticSwarm merged 1 commit into
masterfrom
tongs-readme-documentation
Jun 19, 2026
Merged

Document tongs setup in the README#16
CrypticSwarm merged 1 commit into
masterfrom
tongs-readme-documentation

Conversation

@CrypticSwarm

Copy link
Copy Markdown
Owner

Summary

Document how to set up and use a tong, end to end, in the README.

What this adds

A new ## Tongs (sidecar processes) section covering:

  • Quick start -- the drop-a-YAML-file, run-the-anvil, approve flow.
  • Where definitions live -- the four discovery layers, name-based merge, and
    disable.
  • Definition format -- an annotated example plus the four interface kinds
    (mcp / port / volume / none), readiness modes, and the workspace /
    docker-socket mount magic words.
  • Lifecycle -- session vs shared semantics, config-hash reuse, and how to
    force a restart.
  • Secret providers -- setting up ~/.swarmforge/secret-providers.yaml, the
    ${secret:provider:ref} reference syntax, and the leak-resistant FIFO delivery.
  • First-run approval -- the workspace trust gate and fail-closed behavior.

@CrypticSwarm CrypticSwarm force-pushed the tongs-readme-documentation branch from 37d73b3 to c9eacc1 Compare June 19, 2026 17:38
@CrypticSwarm CrypticSwarm merged commit 1c52170 into master Jun 19, 2026
1 check passed
@CrypticSwarm CrypticSwarm deleted the tongs-readme-documentation branch June 19, 2026 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant