README.md

scripts

Executable scripts live in this directory. This file is the entry index for script usage and script-specific documentation.

Product Contract vs Script Docs

• Product/API behavior (transport, protocol contracts, extension semantics):
  • ../docs/guide.md
• Operator-facing deploy SOP:
  • ../docs/agent_deploy_sop.md
• Security boundary and disclosure guidance:
  • ../SECURITY.md
• Script operational details (how to run and operate each script):
  • kept in this scripts/ directory as *_readme.md

Script Docs Index

• init_release_system_readme.md: release-based host bootstrap for formal deployments (script: init_release_system.sh)
• init_system_readme.md: source-based host bootstrap for contributor/internal debugging (script: init_system.sh)
• deploy_release_readme.md: release-based multi-instance systemd deployment (script: deploy_release.sh)
• deploy_readme.md: source-based multi-instance systemd deployment for contributor/internal debugging (script: deploy.sh)
• uninstall_readme.md: preview-first instance removal (script: uninstall.sh)

Other Scripts

• doctor.sh: local environment consistency checks
• dependency_health.sh: dependency health checks
• lint.sh: lint helper

Notes

• deploy/ contains helper scripts orchestrated by deploy.sh and deploy_release.sh.
• Keep script behavior details in scripts/*_readme.md to avoid drift.