create-orcha 0.4.0 → 0.4.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/package.json +2 -2
- package/template/AGENTS.md +8 -2
- package/template/orcha/AGENTS.md +41 -7
- package/template/orcha/index.ts +3 -0
- package/template/package.json +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-orcha",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "Create a complete OrchaJS project with example agents and a local playground.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"test": "node --test"
|
|
33
33
|
},
|
|
34
34
|
"engines": {
|
|
35
|
-
"node": ">=20"
|
|
35
|
+
"node": ">=18.20.8"
|
|
36
36
|
},
|
|
37
37
|
"publishConfig": {
|
|
38
38
|
"access": "public"
|
package/template/AGENTS.md
CHANGED
|
@@ -9,8 +9,14 @@ frontend or server code is not required.
|
|
|
9
9
|
- `.orcha/sessions/` is the default Node JSONL storage directory and must not
|
|
10
10
|
be committed.
|
|
11
11
|
- `npm run dev` starts `orcha playground`, which watches `orcha/**`.
|
|
12
|
-
- `npm run build` creates
|
|
13
|
-
the playground React
|
|
12
|
+
- `npm run build` creates `.orcha/dist/bundle.js` and
|
|
13
|
+
`.orcha/dist/manifest.json`; it does not include the playground React
|
|
14
|
+
application.
|
|
15
|
+
|
|
16
|
+
When another tool packages an unbundled production application, explicitly
|
|
17
|
+
include `.orcha/dist/**`. A successful `orcha build` does not guarantee that a
|
|
18
|
+
later packager copied generated files. Inspect the final ZIP or container and
|
|
19
|
+
confirm that `.orcha/dist/manifest.json` is present.
|
|
14
20
|
|
|
15
21
|
Use the complete Orcha `AGENTS.md` generated by `orcha init` as the source of
|
|
16
22
|
truth for agent configuration, actions, skills, tests, evaluations, and JSONL
|
package/template/orcha/AGENTS.md
CHANGED
|
@@ -16,12 +16,39 @@ files under `.orcha/`.
|
|
|
16
16
|
pending client-action results.
|
|
17
17
|
- `orcha test` runs every enabled discovered agent test.
|
|
18
18
|
- `orcha test <agent>` or `orcha test <agent>/<case>` narrows the run.
|
|
19
|
+
- `orcha migrate-storage --to sqlite|node-jsonl` copies all session histories
|
|
20
|
+
between local stores without deleting the source.
|
|
21
|
+
- `orcha export-session <agent> <sessionId> [--output <path>]` exports one
|
|
22
|
+
session from the active store as JSONL.
|
|
19
23
|
- `orcha build` creates the production Orcha bundle without calling models.
|
|
20
24
|
- Add `--json` to `run` and `test` for machine-readable output.
|
|
21
25
|
|
|
22
26
|
`run`, `test`, and playground executions use real providers and require
|
|
23
|
-
credentials. `dev` and `build` are offline.
|
|
24
|
-
`.orcha/sessions/<agentName
|
|
27
|
+
credentials. `dev` and `build` are offline. Sessions use JSONL by default
|
|
28
|
+
under `.orcha/sessions/<agentName>/`; opt-in SQLite stores all agents in
|
|
29
|
+
`.orcha/sessions/orcha-sqlite.db`.
|
|
30
|
+
|
|
31
|
+
## Production deployment
|
|
32
|
+
|
|
33
|
+
`orcha build` writes `.orcha/dist/bundle.js` for bundler integrations and
|
|
34
|
+
`.orcha/dist/manifest.json` for unbundled production runtimes. If deployment
|
|
35
|
+
uses plain `tsc`, `serverless-plugin-typescript`, or another packager that
|
|
36
|
+
does not use `orchajs/esbuild`, explicitly include `.orcha/dist/**` in the
|
|
37
|
+
deployment artifact. AWS Lambda loads the manifest automatically; other
|
|
38
|
+
unbundled environments require `NODE_ENV=production` or
|
|
39
|
+
`ORCHA_USE_BUILD=1`.
|
|
40
|
+
|
|
41
|
+
For Serverless Framework manual builds:
|
|
42
|
+
|
|
43
|
+
```yaml
|
|
44
|
+
package:
|
|
45
|
+
patterns:
|
|
46
|
+
- ".orcha/dist/**"
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Do not assume that a successful `orcha build` means the generated files were
|
|
50
|
+
copied by a later packaging tool. Inspect the final ZIP or container image and
|
|
51
|
+
confirm that `.orcha/dist/manifest.json` is present.
|
|
25
52
|
|
|
26
53
|
## Registry
|
|
27
54
|
|
|
@@ -52,9 +79,16 @@ required.
|
|
|
52
79
|
name.
|
|
53
80
|
- `agents` (required): runtime property names mapped to folders relative to
|
|
54
81
|
`orcha/`. At least one agent is required.
|
|
82
|
+
- `amarsia.key` (optional): project connection key generated in Amarsia.
|
|
83
|
+
When set, Orcha syncs structural project and agent metadata only. It never
|
|
84
|
+
uploads provider credentials, environment values, prompts, instructions,
|
|
85
|
+
test inputs, or action source.
|
|
86
|
+
- `amarsia.endpoint` (optional): Amarsia API URL for project sync. Defaults to
|
|
87
|
+
`AMARSIA_API_URL` and then `https://api.amarsia.com`.
|
|
55
88
|
- `actions` (optional): overrides the native local-action runtime or configures
|
|
56
89
|
its environment and sandbox settings.
|
|
57
|
-
- `storage.strategy` (optional):
|
|
90
|
+
- `storage.strategy` (optional): `"node-jsonl"` (default) or `"sqlite"`.
|
|
91
|
+
The SQLite driver ships as an internal optional Orcha dependency.
|
|
58
92
|
- `storage.directory` (optional): session directory relative to project
|
|
59
93
|
root; defaults to `.orcha/sessions`.
|
|
60
94
|
- `root` (optional): absolute or working-directory-relative project root;
|
|
@@ -595,9 +629,9 @@ string, and non-empty evidence array for every configured metric.
|
|
|
595
629
|
|
|
596
630
|
## Sessions and logs
|
|
597
631
|
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
`sequence`.
|
|
632
|
+
The configured session store is the durable source of truth. JSONL stores one
|
|
633
|
+
complete event object per line; SQLite stores one event per row. Events are
|
|
634
|
+
append-only and ordered by `sequence`.
|
|
601
635
|
|
|
602
636
|
All events use this envelope:
|
|
603
637
|
|
|
@@ -1007,7 +1041,7 @@ cause `resume()` to fail spuriously or reuse sequence numbers.
|
|
|
1007
1041
|
|
|
1008
1042
|
### Replay and context
|
|
1009
1043
|
|
|
1010
|
-
Orcha does not send raw
|
|
1044
|
+
Orcha does not send raw stored events back to the model. It projects them
|
|
1011
1045
|
into provider-neutral conversation messages. Completed and explicitly paused
|
|
1012
1046
|
conversational runs become user, assistant, and tool messages, so a new run
|
|
1013
1047
|
sees incomplete assistant text preserved by `pause()`. Lifecycle bookkeeping
|
package/template/orcha/index.ts
CHANGED