ShipMyAgent

ShipMyAgent Docs

Updated user documentation aligned with current package behavior

ShipMyAgent Docs

ShipMyAgent turns a code repository into a conversational, executable, auditable Agent Runtime.

  1. Getting Started
  2. Core Concepts
  3. Configuration Hub
  4. Security & Permissions
  5. Services
  6. Operations
  7. CLI / API Reference

Information Architecture

  • quickstart: install, init, ship.json
  • configuration: layered config, ship.json, model config, rollout checklist
  • security: permission boundaries, runtime isolation, key and data protection
  • services: Skills, Tasks, Telegram, Feishu/Lark, QQ (single entry)
  • extensions: Voice extension usage
  • concepts: architecture, service runtime, extension runtime, relationship/process, message flow
  • operations: logs, troubleshooting, FAQ
  • reference: command reference, HTTP API, .ship/ directory

Scope

These docs are user-facing and based on the current executable CLI and runtime behavior in package/.