open-research-protocol 0.3.0 → 0.4.1
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/INSTALL.md +19 -1
- package/README.md +16 -4
- package/cli/orp.py +1598 -14
- package/docs/DISCOVER.md +9 -13
- package/docs/NPM_RELEASE_CHECKLIST.md +7 -7
- package/docs/ORP_PUBLIC_LAUNCH_CHECKLIST.md +64 -0
- package/docs/ORP_WEB_DOMAIN_TRANSITION_PLAN.md +106 -0
- package/package.json +1 -1
- package/docs/CODA_ORP_CONTRACT.md +0 -222
package/INSTALL.md
CHANGED
|
@@ -7,6 +7,7 @@ ORP supports both:
|
|
|
7
7
|
|
|
8
8
|
The default runtime story is now:
|
|
9
9
|
|
|
10
|
+
- `orp auth ...`, `orp ideas ...`, `orp feature ...`, `orp world ...`, `orp checkpoint ...`, and `orp agent ...` for hosted workspace work
|
|
10
11
|
- `orp discover ...` for profile-based GitHub scanning and opportunity selection
|
|
11
12
|
- `orp collaborate ...` for repository collaboration
|
|
12
13
|
- `orp erdos ...` for Erdos-specific workflows
|
|
@@ -30,6 +31,12 @@ Agent-friendly discovery surfaces:
|
|
|
30
31
|
|
|
31
32
|
- bare `orp` for the CLI home screen with packs, repo status, and quick actions
|
|
32
33
|
- `orp home --json` for machine-readable landing context
|
|
34
|
+
- `orp auth login` for hosted workspace login
|
|
35
|
+
- `orp whoami --json` for the current hosted identity
|
|
36
|
+
- `orp ideas list --json` for hosted idea listing
|
|
37
|
+
- `orp world bind --idea-id <idea-id> --project-root /abs/path --codex-session-id <session-id> --json` for hosted world binding
|
|
38
|
+
- `orp checkpoint queue --idea-id <idea-id> --json` for queueing a hosted checkpoint
|
|
39
|
+
- `orp agent work --once --json` for processing one hosted checkpoint job
|
|
33
40
|
- `orp discover profile init --json` for a portable discovery profile scaffold
|
|
34
41
|
- `orp discover github scan --profile orp.profile.default.json --json` for ranked GitHub repo/issue/person recommendations
|
|
35
42
|
- `orp collaborate init` for immediate collaboration scaffolding
|
|
@@ -37,7 +44,7 @@ Agent-friendly discovery surfaces:
|
|
|
37
44
|
- `orp collaborate gates --workflow full_flow --json` for the exact gate chain
|
|
38
45
|
- `llms.txt` for quick repo/package discovery
|
|
39
46
|
- `orp about --json` for machine-readable capabilities, schemas, artifacts, and bundled packs
|
|
40
|
-
- `docs/DISCOVER.md` for the discovery profile model and
|
|
47
|
+
- `docs/DISCOVER.md` for the discovery profile model and scan artifacts
|
|
41
48
|
- `docs/AGENT_LOOP.md` for the intended agent operating rhythm
|
|
42
49
|
- `orp pack list --json` for machine-readable bundled pack inventory
|
|
43
50
|
|
|
@@ -52,6 +59,17 @@ orp collaborate run --workflow full_flow --json
|
|
|
52
59
|
This uses ORP's built-in collaboration ability. You do not need to think in
|
|
53
60
|
terms of separate governance packs for the default collaboration path.
|
|
54
61
|
|
|
62
|
+
Fastest hosted workspace loop from the published ORP binary:
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
orp auth login
|
|
66
|
+
orp whoami --json
|
|
67
|
+
orp ideas list --json
|
|
68
|
+
orp world bind --idea-id <idea-id> --project-root /abs/path --codex-session-id <session-id> --json
|
|
69
|
+
orp checkpoint queue --idea-id <idea-id> --json
|
|
70
|
+
orp agent work --once --json
|
|
71
|
+
```
|
|
72
|
+
|
|
55
73
|
To choose where collaboration should start, scaffold a profile first:
|
|
56
74
|
|
|
57
75
|
```sh
|
package/README.md
CHANGED
|
@@ -21,7 +21,6 @@ verification remains independent of framing. See `modules/instruments/README.md`
|
|
|
21
21
|
- `PROTOCOL.md` — the protocol to copy into a project
|
|
22
22
|
- `INSTALL.md` — how to adopt ORP in an existing repo or start a new project from it
|
|
23
23
|
- `docs/AGENT_LOOP.md` — canonical operating loop when an agent is the primary ORP user
|
|
24
|
-
- `docs/CODA_ORP_CONTRACT.md` — boundary between Coda app/wrapper concerns and ORP runtime concerns
|
|
25
24
|
- `docs/EXTERNAL_CONTRIBUTION_GOVERNANCE.md` — canonical local-first workflow for external OSS PR work
|
|
26
25
|
- `docs/OSS_CONTRIBUTION_AGENT_LOOP.md` — agent operating rhythm for external contribution workflows
|
|
27
26
|
- `templates/` — claim, verification, failure, and issue templates
|
|
@@ -39,6 +38,7 @@ verification remains independent of framing. See `modules/instruments/README.md`
|
|
|
39
38
|
|
|
40
39
|
ORP should feel like one CLI with built-in abilities:
|
|
41
40
|
|
|
41
|
+
- `workspace` for hosted auth, idea, feature, world, checkpoint, and worker operations
|
|
42
42
|
- `discover` for profile-based GitHub scanning and opportunity selection
|
|
43
43
|
- `collaborate` for repository collaboration setup and workflow execution
|
|
44
44
|
- `erdos` for Erdos-specific data and workflow support
|
|
@@ -95,6 +95,12 @@ Agent-first discovery surfaces:
|
|
|
95
95
|
orp
|
|
96
96
|
orp home --json
|
|
97
97
|
orp about --json
|
|
98
|
+
orp auth login
|
|
99
|
+
orp whoami --json
|
|
100
|
+
orp ideas list --json
|
|
101
|
+
orp world bind --idea-id <idea-id> --project-root /abs/path --codex-session-id <session-id> --json
|
|
102
|
+
orp checkpoint queue --idea-id <idea-id> --json
|
|
103
|
+
orp agent work --once --json
|
|
98
104
|
orp discover profile init --json
|
|
99
105
|
orp discover github scan --profile orp.profile.default.json --json
|
|
100
106
|
orp collaborate workflows --json
|
|
@@ -112,11 +118,12 @@ These surfaces are meant to help automated systems discover ORP quickly:
|
|
|
112
118
|
|
|
113
119
|
- bare `orp` opens a home screen with repo/runtime status, available packs, and next commands
|
|
114
120
|
- `orp home --json` returns the same landing context in machine-readable form
|
|
115
|
-
- `orp
|
|
121
|
+
- `orp auth ...`, `orp ideas ...`, `orp world ...`, `orp checkpoint ...`, and `orp agent ...` expose the hosted workspace surface directly through ORP
|
|
122
|
+
- `orp discover ...` exposes profile-based GitHub scanning as a built-in ORP ability
|
|
116
123
|
- `orp collaborate ...` exposes built-in collaboration setup and workflow execution without asking users to think in terms of separate governance packs
|
|
117
124
|
- `llms.txt` gives a concise repo/package map for agents that scan documentation.
|
|
118
125
|
- `docs/AGENT_LOOP.md` gives agents one intended operating rhythm instead of leaving them to invent one.
|
|
119
|
-
- `docs/DISCOVER.md` explains the portable discovery profile model and
|
|
126
|
+
- `docs/DISCOVER.md` explains the portable discovery profile model and scan artifacts.
|
|
120
127
|
- `orp about --json` returns machine-readable capability, artifact, schema, and pack metadata.
|
|
121
128
|
- Core runtime and pack commands can emit JSON so agents do not need to scrape human text.
|
|
122
129
|
- Stable artifact paths make it easy to follow outputs across runs:
|
|
@@ -131,6 +138,7 @@ These surfaces are meant to help automated systems discover ORP quickly:
|
|
|
131
138
|
Release process:
|
|
132
139
|
|
|
133
140
|
- `docs/NPM_RELEASE_CHECKLIST.md`
|
|
141
|
+
- `docs/ORP_PUBLIC_LAUNCH_CHECKLIST.md`
|
|
134
142
|
- `.github/workflows/npm-publish.yml` (publishes on `v*` tags)
|
|
135
143
|
|
|
136
144
|
## Quick start (existing repo)
|
|
@@ -163,11 +171,15 @@ ORP remains docs-first by default. For teams that want local gate execution and
|
|
|
163
171
|
Minimal CLI skeleton:
|
|
164
172
|
|
|
165
173
|
```bash
|
|
174
|
+
orp auth login
|
|
175
|
+
orp ideas list --json
|
|
176
|
+
orp world bind --idea-id <idea-id> --project-root /abs/path --codex-session-id <session-id> --json
|
|
177
|
+
orp checkpoint queue --idea-id <idea-id> --json
|
|
178
|
+
orp agent work --once --json
|
|
166
179
|
orp init
|
|
167
180
|
orp gate run --profile default
|
|
168
181
|
orp packet emit --profile default
|
|
169
182
|
orp report summary --run-id <run_id>
|
|
170
|
-
orp pack list
|
|
171
183
|
orp erdos sync
|
|
172
184
|
```
|
|
173
185
|
|