Skip to content

Document traverse-cli serve as a development/CI HTTP API; direct production apps to embedded hosts #810

Description

@enricopiovesan

Product decision

Embedded hosts are the production path. traverse-cli serve remains a supported development and CI HTTP API; it is not the default topology for shipped product apps.

Governing specs

  • 033-http-json-api
  • 046-public-cli-app-registration
  • 057-embeddable-runtime-host
  • 068-public-platform-embedder-packages

Scope

  • Correct CLI help, docs, and error guidance that could imply HTTP is the production path.
  • Retain a worked generic register → execute example for development, diagnosis, and CI.
  • Link production consumers to public embedder guidance.

Definition of Done

  • serve help and docs call it a development/CI HTTP API.
  • Generic registration/execution guidance remains available but is explicitly non-production.
  • Production docs point to embedded runtime packages and state that no loopback sidecar or .traverse/server.json discovery is required.
  • agent execute errors distinguish the embedded production path from the development HTTP API.
  • Documentation links and CLI-help snapshots pass.

Non-goals

  • A hosted or multi-tenant remote execution product.
  • Deprecating the developer HTTP API.
  • Changing runtime execution semantics.

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent:codexClaimed by CodexclidocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions