docs: complete reference docs.md (replaces internal draft)#16
Merged
Conversation
….sh draft)
The previous docs.md was an internal-only API reference for the
hand-rolled api.clawagent.sh deployment — full of customer URLs and
hosted-endpoint specifics. It was gitignored back in the
chore/oss-cleanup-public sweep.
This commit replaces it with a complete public-facing reference and
un-gitignores the path.
Contents:
- Install + quickstart
- Core API: ComputerAgent, ChatHandle, runTask (with full options
table cross-checked against ComputerAgentOptions in packages/sdk/
src/types.ts)
- IdentitySource: git / local / inline + string shorthand
- Substrates: Local / Bwrap / E2B / VZ with package + startup notes
- Engines: claude-agent-sdk / gitagent / deepagents + custom path
- Session stores: memory / file / mongo / sqlite + resume pattern
- Telemetry: AgentTelemetry (library-mode) + AuditSink (server-mode)
- Permissions: onToolCall, ttyApproval, manual iteration
- Policy: SRS-backed Cedar + OPA guardrails
- Configuration: env var matrix, model override resolution order
- HTTP wire protocol: REST endpoints + SSE event union + curl example
- CLI flag table
- Typed errors
- Companion package map
- Versioning policy
Sections cross-link to README.md, packages/computeragent/info.md
(architecture), CHANGELOG, CONTRIBUTING, SECURITY.
Audit: 0 customer-name leaks (lyzr/nordstrom/clawagent/shreyas-lyzr).
560 lines.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces the gitignored internal
docs.md(api.clawagent.sh API ref) with a complete public-facing reference and un-gitignores the path.What's in it (16 sections, 560 lines)
ComputerAgent,ChatHandle,runTask(full options table verified againstComputerAgentOptionsin packages/sdk/src/types.ts)IdentitySource: git / local / inline + string shorthandAgentTelemetry(library-mode) +AuditSink(server-mode), gen_ai.* OTelHarnessProtocolError,UnknownEngineError, …)Verified
lyzr/nordstrom/clawagent/shreyas-lyzraudit clean)cagent,agent.run, or other vaporware)Companion to:
README.md— install + the "why"packages/computeragent/info.md— architecture deep-dive + diagrams