Documentation
¶
Overview ¶
Package arvelsdk is the root of the Arvel SDK module.
The module is the Go reference implementation of the Arvel Provider Protocol. The importable packages live in sub-directories (protocol, manifest, schema, plugin, procx, jsonl, redact, logx, testkit); this root package only carries the module documentation.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
arvel-plugin-check
command
Command arvel-plugin-check verifies that a plugin conforms to the Arvel Provider Protocol (docs/PROTOCOL.md).
|
Command arvel-plugin-check verifies that a plugin conforms to the Arvel Provider Protocol (docs/PROTOCOL.md). |
|
examples
|
|
|
echo
command
Command echo is a minimal Arvel provider plugin: an in-memory echo with one connection kind "local" and one model "echo-1".
|
Command echo is a minimal Arvel provider plugin: an in-memory echo with one connection kind "local" and one model "echo-1". |
|
echo-router
command
Command echo-router is a minimal Arvel router plugin: deterministic keyword rules, no network, no secrets.
|
Command echo-router is a minimal Arvel router plugin: deterministic keyword rules, no network, no secrets. |
|
internal
|
|
|
fakeclock
Package fakeclock is a deterministic clock for tests.
|
Package fakeclock is a deterministic clock for tests. |
|
jsoneq
Package jsoneq compares JSON documents semantically for golden tests.
|
Package jsoneq compares JSON documents semantically for golden tests. |
|
leakcheck
Package leakcheck is a test helper that fails a test when goroutines of the named packages are still running.
|
Package leakcheck is a test helper that fails a test when goroutines of the named packages are still running. |
|
protodoc
Package protodoc extracts the JSON examples from docs/PROTOCOL.md so tests can bind every example to a typed value.
|
Package protodoc extracts the JSON examples from docs/PROTOCOL.md so tests can bind every example to a typed value. |
|
tools/spdxcheck
command
Command spdxcheck verifies that every .go file starts with the SPDX licence header required for its directory.
|
Command spdxcheck verifies that every .go file starts with the SPDX licence header required for its directory. |
|
Package jsonl frames newline-delimited JSON, the transport of the Arvel Provider Protocol (PROTOCOL §2).
|
Package jsonl frames newline-delimited JSON, the transport of the Arvel Provider Protocol (PROTOCOL §2). |
|
Package jsonrpc is the bidirectional, line-delimited JSON-RPC 2.0 peer of the Arvel Provider Protocol (PROTOCOL §2).
|
Package jsonrpc is the bidirectional, line-delimited JSON-RPC 2.0 peer of the Arvel Provider Protocol (PROTOCOL §2). |
|
Package logx builds the logger of PROTOCOL §10: JSON lines on stderr with the keys ts, level, msg, plugin and pid, the level taken from ARVEL_LOG_LEVEL, and every string run through a redact.Redactor.
|
Package logx builds the logger of PROTOCOL §10: JSON lines on stderr with the keys ts, level, msg, plugin and pid, the level taken from ARVEL_LOG_LEVEL, and every string run through a redact.Redactor. |
|
Package manifest loads and validates arvel.json, the manifest of an Arvel plugin (docs/PROTOCOL.md §3.2, §4, §14.1, §16).
|
Package manifest loads and validates arvel.json, the manifest of an Arvel plugin (docs/PROTOCOL.md §3.2, §4, §14.1, §16). |
|
Package plugin is the framework for Arvel plugins.
|
Package plugin is the framework for Arvel plugins. |
|
Package procx holds the cross-platform process helpers every vendor plugin uses: finding a binary, probing its version, building a minimal environment, and starting and killing whole process trees on Linux, macOS and Windows.
|
Package procx holds the cross-platform process helpers every vendor plugin uses: finding a binary, probing its version, building a minimal environment, and starting and killing whole process trees on Linux, macOS and Windows. |
|
Package protocol defines the wire types of the Arvel Provider Protocol v1 (docs/PROTOCOL.md): the "_meta.arvel" structures, the "_arvel/*" request and result bodies, the error model and the router types.
|
Package protocol defines the wire types of the Arvel Provider Protocol v1 (docs/PROTOCOL.md): the "_meta.arvel" structures, the "_arvel/*" request and result bodies, the error model and the router types. |
|
skills
Package skills delivers the Agent Skills folders the Arvel host prepares for a session (PROTOCOL §7.1 item 5a) to a vendor CLI that reads project skills from a directory inside the session's working directory.
|
Package skills delivers the Agent Skills folders the Arvel host prepares for a session (PROTOCOL §7.1 item 5a) to a vendor CLI that reads project skills from a directory inside the session's working directory. |
|
Package redact scrubs secrets from text destined for logs and errors.
|
Package redact scrubs secrets from text destined for logs and errors. |
|
Package schema embeds the JSON Schema of arvel.json.
|
Package schema embeds the JSON Schema of arvel.json. |
|
testkit
|
|
|
fakevendor
Package fakevendor builds a fake vendor CLI from a YAML script (SPEC §5.9).
|
Package fakevendor builds a fake vendor CLI from a YAML script (SPEC §5.9). |
|
fakevendor/cmd
command
Command fakevendor replays a fake-vendor script from a file.
|
Command fakevendor replays a fake-vendor script from a file. |
|
mockhost
Package mockhost is the scripted ACP client of the testkit (SPEC §5.9).
|
Package mockhost is the scripted ACP client of the testkit (SPEC §5.9). |
|
scenario
Package scenario defines the YAML scenario format shared by the SDK tests and arvel-plugin-check (SPEC §5.9).
|
Package scenario defines the YAML scenario format shared by the SDK tests and arvel-plugin-check (SPEC §5.9). |
Click to show internal directories.
Click to hide internal directories.