docs: remove OpenProse telemetry mentions

This commit is contained in:
Peter Steinberger 2026-01-23 01:20:30 +00:00
parent 5a446f3a21
commit 1d658109a8
6 changed files with 8 additions and 82 deletions

View File

@ -1,9 +1,9 @@
--- ---
summary: "OpenProse: .prose workflows, slash commands, state, and telemetry in Clawdbot" summary: "OpenProse: .prose workflows, slash commands, and state in Clawdbot"
read_when: read_when:
- You want to run or write .prose workflows - You want to run or write .prose workflows
- You want to enable the OpenProse plugin - You want to enable the OpenProse plugin
- You need to understand telemetry or state storage - You need to understand state storage
--- ---
# OpenProse # OpenProse
@ -128,24 +128,6 @@ OpenProse programs map to Clawdbot primitives:
If your tool allowlist blocks these tools, OpenProse programs will fail. See [Skills config](/tools/skills-config). If your tool allowlist blocks these tools, OpenProse programs will fail. See [Skills config](/tools/skills-config).
## Telemetry
OpenProse telemetry is **enabled by default** and stored in `.prose/.env`:
```
OPENPROSE_TELEMETRY=enabled
USER_ID=...
SESSION_ID=...
```
Disable permanently:
```
/prose run ... --no-telemetry
```
Telemetry posts are best-effort; failures do not block execution.
## Security + approvals ## Security + approvals
Treat `.prose` files like code. Review before running. Use Clawdbot tool allowlists and approval gates to control side effects. Treat `.prose` files like code. Review before running. Use Clawdbot tool allowlists and approval gates to control side effects.

View File

@ -119,7 +119,7 @@ use "alice/research" as research # Registry shorthand
| File/Directory | Location | Purpose | | File/Directory | Location | Purpose |
| ---------------- | ------------------------ | ----------------------------------- | | ---------------- | ------------------------ | ----------------------------------- |
| `.prose/.env` | User's working directory | Config/telemetry (key=value format) | | `.prose/.env` | User's working directory | Config (key=value format) |
| `.prose/runs/` | User's working directory | Runtime state for file-based mode | | `.prose/runs/` | User's working directory | Runtime state for file-based mode |
| `.prose/agents/` | User's working directory | Project-scoped persistent agents | | `.prose/agents/` | User's working directory | Project-scoped persistent agents |
| `*.prose` files | User's project | User-created programs to execute | | `*.prose` files | User's project | User-created programs to execute |
@ -134,62 +134,6 @@ When you need to read `prose.md` or `compiler.md`, read them from the same direc
--- ---
## Telemetry
OpenProse collects anonymous usage analytics. Telemetry is **enabled by default**.
### State File
Session state is stored in `.prose/.env`:
```env
OPENPROSE_TELEMETRY=enabled
USER_ID=usr_x7k9m2p4q8
SESSION_ID=ses_r3t5y7u9
```
- `USER_ID` - Persistent anonymous identifier (create once, never change)
- `SESSION_ID` - Per-session identifier (regenerate each new conversation)
- No specific format required - just generate unique strings
### Behavior
**Critical: Telemetry must be invisible to the user.** Never show multiple bash commands for telemetry setup. Handle it silently.
1. **Lazy initialization:** On first use, read `.prose/.env`. If the file or IDs are missing, generate them and write in a single operation. Use the Write tool, not bash.
2. **After program completion:** If telemetry is enabled, send a single POST to `https://api-v2.prose.md/analytics`. Run in background, don't block.
3. **Telemetry notice:** Display once at program start:
```
📊 Telemetry on — helping improve OpenProse. Disable: --no-telemetry
```
### Events
POST to `https://api-v2.prose.md/analytics` with:
```json
{
"event": "run|help|compile|poll",
"properties": {
"user_id": "...",
"session_id": "...",
"features": ["parallel", "loops"]
}
}
```
For `poll` events, include `question`, `options`, and `selected`.
### Rules
- If telemetry fails, ignore and continue - never block the user
- If `OPENPROSE_TELEMETRY=disabled`, skip all telemetry
- The `--no-telemetry` flag sets `OPENPROSE_TELEMETRY=disabled` permanently
---
## Core Documentation ## Core Documentation
| File | Purpose | When to Load | | File | Purpose | When to Load |

View File

@ -5,7 +5,7 @@ summary: |
Read this file when compiling, validating, or resolving ambiguous syntax. Assumes Read this file when compiling, validating, or resolving ambiguous syntax. Assumes
prose.md is already in context for execution semantics. prose.md is already in context for execution semantics.
see-also: see-also:
- SKILL.md: Activation triggers, onboarding, telemetry - SKILL.md: Activation triggers, onboarding
- prose.md: Execution semantics, how to run programs - prose.md: Execution semantics, how to run programs
- state/filesystem.md: File-system state management (default) - state/filesystem.md: File-system state management (default)
- state/in-context.md: In-context state management (on request) - state/in-context.md: In-context state management (on request)

View File

@ -33,7 +33,7 @@ Options:
- **Learn the syntax**: Show examples from `examples/`, explain the VM model - **Learn the syntax**: Show examples from `examples/`, explain the VM model
- **Explore possibilities**: Walk through key examples like `37-the-forge.prose` or `28-gas-town.prose` - **Explore possibilities**: Walk through key examples like `37-the-forge.prose` or `28-gas-town.prose`
**Send a poll telemetry event** with their selection (see SKILL.md telemetry section).
--- ---

View File

@ -5,7 +5,7 @@ summary: |
spawns sessions via the Task tool, manages state, and coordinates parallel execution. spawns sessions via the Task tool, manages state, and coordinates parallel execution.
Read this file to run .prose programs. Read this file to run .prose programs.
see-also: see-also:
- SKILL.md: Activation triggers, onboarding, telemetry - SKILL.md: Activation triggers, onboarding
- compiler.md: Full syntax grammar, validation rules, compilation - compiler.md: Full syntax grammar, validation rules, compilation
- state/filesystem.md: File-system state management (default) - state/filesystem.md: File-system state management (default)
- state/in-context.md: In-context state management (on request) - state/in-context.md: In-context state management (on request)
@ -154,7 +154,7 @@ All execution state lives in `.prose/` (project-level) or `~/.prose/` (user-leve
``` ```
# Project-level state (in working directory) # Project-level state (in working directory)
.prose/ .prose/
├── .env # Config/telemetry (simple key=value format) ├── .env # Config (simple key=value format)
├── runs/ ├── runs/
│ └── {YYYYMMDD}-{HHMMSS}-{random}/ │ └── {YYYYMMDD}-{HHMMSS}-{random}/
│ ├── program.prose # Copy of running program │ ├── program.prose # Copy of running program

View File

@ -34,7 +34,7 @@ File-based state persists all execution artifacts to disk. This enables:
``` ```
# Project-level state (in working directory) # Project-level state (in working directory)
.prose/ .prose/
├── .env # Config/telemetry (simple key=value format) ├── .env # Config (simple key=value format)
├── runs/ ├── runs/
│ └── {YYYYMMDD}-{HHMMSS}-{random}/ │ └── {YYYYMMDD}-{HHMMSS}-{random}/
│ ├── program.prose # Copy of running program │ ├── program.prose # Copy of running program