@getopencrawl/cli-darwin-arm64 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -0
- package/bin/opencrawl +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -107,3 +107,40 @@ After signing in, run `opencrawl collect install` to install Claude Code and Cod
|
|
|
107
107
|
`opencrawl collect status --json` reports the enrolled identity, queued uploads, last receipt and errors. `collect sync` reconciles active transcripts; `collect flush` retries queued uploads; `collect uninstall` removes OpenCrawl hooks and stops collection while preserving queued data.
|
|
108
108
|
|
|
109
109
|
Messages, tool arguments/results and attachments are collected with native session IDs and a stable installation ID. System/developer prompts are excluded. The hosted service derives ownership from login. Self-hosted users can supply `OPENCRAWL_SESSIONS_TOKEN` and `--api` for the portable receiver. See [capture architecture and limits](../docs/session-capture.md).
|
|
110
|
+
|
|
111
|
+
### Claude Code cloud
|
|
112
|
+
|
|
113
|
+
Cloud sessions run on a fresh Linux VM. Local hooks do not transfer. The first
|
|
114
|
+
setup prompt should direct hosted users to their deployment's `/capture/cloud`
|
|
115
|
+
page, which issues a one-year, revocable, upload-only credential and supplies the
|
|
116
|
+
exact setup script. Use a **personal** Claude environment: sessions using that
|
|
117
|
+
credential are attributed to its owner, regardless of who starts them.
|
|
118
|
+
|
|
119
|
+
Keep Limited/Trusted networking and allow the deployment's API hostname plus
|
|
120
|
+
npm registries. Add `OPENCRAWL_SESSIONS_TOKEN` in Environment variables and append
|
|
121
|
+
the provided script to Setup script. Save and start a fresh session using that
|
|
122
|
+
environment. No local Claude installation is required. Human-only settings and
|
|
123
|
+
a separate setup session are supported. Environment variables are visible to
|
|
124
|
+
commands in that environment; don't paste the credential into the chat or repo.
|
|
125
|
+
|
|
126
|
+
The installer detects `CLAUDE_CODE_REMOTE=true`, installs Claude hooks only and
|
|
127
|
+
skips systemd. `--harness claude-code --no-background` also selects this explicitly.
|
|
128
|
+
The setup installs the CLI at
|
|
129
|
+
`$HOME/.local/share/opencrawl-cloud/node_modules/.bin/opencrawl`. After a user
|
|
130
|
+
message, tool call and image, `collect status` must report a stored receipt and
|
|
131
|
+
no error. Don't use manual sync as evidence that automatic hooks work. Search
|
|
132
|
+
follows asynchronous indexing, not the upload acknowledgement.
|
|
133
|
+
|
|
134
|
+
Cloud batches retain the native session UUID and the web session ID from the
|
|
135
|
+
native `remote_session_change` attachment, and mark origin `cloud`. Internal
|
|
136
|
+
prompt snapshots, environment snapshots and repeated tool/MCP listings are
|
|
137
|
+
omitted. Image attachment bytes are stored separately using their digest.
|
|
138
|
+
|
|
139
|
+
Self-hosted operators use the same protocol: with the configured receiver token,
|
|
140
|
+
POST `/api/sessions/credentials` to obtain an upload-only delegation, store the
|
|
141
|
+
returned token directly in a private file (not a transcript), then configure the
|
|
142
|
+
personal environment above using their HTTPS receiver hostname. DELETE
|
|
143
|
+
`/api/sessions/credentials/<id>` with the receiver token revokes it. The child
|
|
144
|
+
credential cannot search/read, issue credentials or revoke credentials. The
|
|
145
|
+
receiver always binds the operator's fixed tenant/user, including for delegated
|
|
146
|
+
tokens. Changing that fixed identity invalidates old delegations.
|
package/bin/opencrawl
CHANGED