@orkestrel/agent 0.0.28 → 0.0.30
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 +11 -5
- package/dist/src/core/index.cjs +6703 -4014
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +2825 -872
- package/dist/src/core/index.d.ts +2825 -872
- package/dist/src/core/index.js +6636 -4013
- package/dist/src/core/index.js.map +1 -1
- package/package.json +17 -17
package/README.md
CHANGED
|
@@ -15,17 +15,23 @@ own server. Callable tools come from `@orkestrel/tool` and documents from
|
|
|
15
15
|
|
|
16
16
|
## Install
|
|
17
17
|
|
|
18
|
+
Install the package from npm:
|
|
19
|
+
|
|
18
20
|
```sh
|
|
19
21
|
npm install @orkestrel/agent
|
|
20
22
|
```
|
|
21
23
|
|
|
22
24
|
## Requirements
|
|
23
25
|
|
|
24
|
-
|
|
26
|
+
The package targets the following runtime and module formats:
|
|
27
|
+
|
|
28
|
+
- Node.js >= 22.12.0
|
|
25
29
|
- Dual ESM + CommonJS builds (`import` and `require` both supported)
|
|
26
30
|
|
|
27
31
|
## Usage
|
|
28
32
|
|
|
33
|
+
The following example builds an agent with one tool and streams a turn:
|
|
34
|
+
|
|
29
35
|
```ts
|
|
30
36
|
import { createAgent } from '@orkestrel/agent'
|
|
31
37
|
import { createTool, createToolManager } from '@orkestrel/tool'
|
|
@@ -52,11 +58,11 @@ const result = await stream.result // { content, usage?, partial }
|
|
|
52
58
|
|
|
53
59
|
## Guide
|
|
54
60
|
|
|
55
|
-
[
|
|
61
|
+
See [Agent](guides/agent.md) for the agent-owned surface:
|
|
56
62
|
the provider boundary, the `AgentProvider` HTTP engine, the relay, conversations,
|
|
57
|
-
instructions, scopes, authority, durable jobs, the loop,
|
|
58
|
-
packages it consumes are mirrored alongside it
|
|
59
|
-
for callable tools and [
|
|
63
|
+
instructions, scopes, authority, durable jobs, the loop, `AgentContext`, and the
|
|
64
|
+
ledger. The packages it consumes are mirrored alongside it; see
|
|
65
|
+
[Tool](guides/tool.md) for callable tools and [Workspace](guides/workspace.md) for files.
|
|
60
66
|
|
|
61
67
|
## Package
|
|
62
68
|
|