@cassiomc1/forgeloop 1.6.1 → 1.6.3
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 +49 -26
- package/docs/GETTING_STARTED.md +10 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -74,11 +74,34 @@ frontmatter. Repository validators keep the catalog and metadata synchronized.
|
|
|
74
74
|
|
|
75
75
|
## Quickstart
|
|
76
76
|
|
|
77
|
-
###
|
|
77
|
+
### Installation
|
|
78
78
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
79
|
+
Install the ForgeLoop CLI globally to make the `forgeloop` command available
|
|
80
|
+
in your terminal:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
npm install --global @cassiomc1/forgeloop
|
|
84
|
+
forgeloop --version
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Then, inside your project repository:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
forgeloop init
|
|
91
|
+
forgeloop doctor
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
If you prefer not to install globally, use `npx`:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
npx @cassiomc1/forgeloop init
|
|
98
|
+
npx @cassiomc1/forgeloop doctor
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### 60-second demonstration
|
|
102
|
+
|
|
103
|
+
In a disposable directory, initialize the kit and create an isolated task. The
|
|
104
|
+
result is deterministic and can be inspected by any compatible harness:
|
|
82
105
|
|
|
83
106
|
```bash
|
|
84
107
|
npx @cassiomc1/forgeloop init
|
|
@@ -88,20 +111,20 @@ forgeloop preflight --task demo --json
|
|
|
88
111
|
forgeloop next --task demo --json
|
|
89
112
|
```
|
|
90
113
|
|
|
91
|
-
|
|
92
|
-
|
|
114
|
+
The last command reports the next safe action; it does not execute code or
|
|
115
|
+
schedule agents.
|
|
93
116
|
|
|
94
|
-
###
|
|
117
|
+
### Durable external actions
|
|
95
118
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
119
|
+
For external effects, record intent with `action-propose`, apply the capability
|
|
120
|
+
policy and fingerprint-bound approval, and execute only with `run-action` using
|
|
121
|
+
the exact argv. A `COMMIT_UNKNOWN` result is never repeated automatically:
|
|
122
|
+
observe the external system and use `action-reconcile`. Metrics keep
|
|
123
|
+
tokens/costs unknown when the host does not provide them, and efficiency exists
|
|
124
|
+
only when a reference scenario has been declared.
|
|
102
125
|
|
|
103
|
-
|
|
104
|
-
|
|
126
|
+
Before a harness creates or resumes a task, it can confirm public compatibility
|
|
127
|
+
without depending on internal details:
|
|
105
128
|
|
|
106
129
|
<!-- FORGELOOP EXAMPLE: readme:compatibility | exit=0 | json.protocolVersion=1 -->
|
|
107
130
|
```bash
|
|
@@ -109,18 +132,18 @@ forgeloop protocol-info --json
|
|
|
109
132
|
```
|
|
110
133
|
<!-- END FORGELOOP EXAMPLE -->
|
|
111
134
|
|
|
112
|
-
###
|
|
135
|
+
### Responsibilities
|
|
113
136
|
|
|
114
|
-
|
|
|
137
|
+
| Responsibility | ForgeLoop | Harness or developer |
|
|
115
138
|
| --- | --- | --- |
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
|
119
|
-
|
|
|
120
|
-
|
|
|
139
|
+
| Validate contract and routes | Yes | Provides intent and signals |
|
|
140
|
+
| Implement code | No | Yes |
|
|
141
|
+
| Record command provenance | Yes, with `run-check` | Provides command and environment |
|
|
142
|
+
| Validate completion | Yes | Provides real work and evidence |
|
|
143
|
+
| Schedule agents or LLM inference | No | External to the protocol |
|
|
121
144
|
|
|
122
|
-
|
|
123
|
-
[
|
|
145
|
+
For a concrete exchange between tools, see
|
|
146
|
+
[cross-harness continuity](./docs/CROSS_HARNESS_CONTINUITY.md).
|
|
124
147
|
|
|
125
148
|
From a published package, initialize a target project with:
|
|
126
149
|
|
|
@@ -347,8 +370,8 @@ repository policy allows only ESLint and c8 as development dependencies;
|
|
|
347
370
|
appear. The documentation renderer is vendored and pinned under
|
|
348
371
|
`vendor/archify/v2.15.0/` rather than installed as a package dependency.
|
|
349
372
|
|
|
350
|
-
|
|
351
|
-
[`SECURITY.md`](./SECURITY.md)
|
|
373
|
+
To report vulnerabilities or contribute changes, see
|
|
374
|
+
[`SECURITY.md`](./SECURITY.md) and [`CONTRIBUTING.md`](./CONTRIBUTING.md).
|
|
352
375
|
|
|
353
376
|
## Autonomous blind-run isolation
|
|
354
377
|
|
package/docs/GETTING_STARTED.md
CHANGED
|
@@ -37,6 +37,16 @@ Core mental model:
|
|
|
37
37
|
|
|
38
38
|
## 3. Installation & Initialization
|
|
39
39
|
|
|
40
|
+
### Global installation
|
|
41
|
+
|
|
42
|
+
Install the ForgeLoop CLI globally to make the `forgeloop` command available
|
|
43
|
+
in your terminal:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npm install --global @cassiomc1/forgeloop
|
|
47
|
+
forgeloop --version
|
|
48
|
+
```
|
|
49
|
+
|
|
40
50
|
In your project repository:
|
|
41
51
|
|
|
42
52
|
Confirm the installed CLI exposes the compatible protocol before creating
|