@agenticrun/sdk 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,60 @@
+# @agenticrun/sdk
+
+Agenticrun SDK for trusted Node.js applications (Node.js 24.12 or newer, ESM).
+The SDK loads managed agent configuration and credentials from Agenticrun and
+sends session traces to the backend. Never use it in a browser or expose the
+Agent API key or returned provider credential to end users.
+
+## LangChain
+
+```sh
+npm install @agenticrun/sdk@alpha langchain
+```
+
+Set `AGENTICRUN_AGENT_API_KEY` to your Agent API key. Optionally set
+`AGENTICRUN_API_URL` (default: `https://api.agenticrun.de/v1`).
+
+```ts
+import { createAgenticRun } from '@agenticrun/sdk/langchain'
+import { createAgent } from 'langchain'
+
+const { model, middleware, createSession } = await createAgenticRun()
+const agent = createAgent({ model, middleware })
+const session = createSession()
+const result = await agent.invoke({ messages: [{ role: 'user', content: 'Hello!' }] }, session.createInvocationConfig())
+```
+
+## Framework-independent core
+
+```ts
+import { createAgenticRunClient } from '@agenticrun/sdk'
+
+const client = await createAgenticRunClient()
+const session = client.createSession()
+const trace = session.createTrace({ rootSpan: { name: 'my-agent', spanType: 'agent' } })
+await trace.started
+trace.rootSpan.complete({ status: 'success', output: { type: 'text', text: 'Hello!' } })
+await trace.complete('success')
+```
+
+The root entrypoint does not load LangChain. Both entrypoints belong to the same
+package. Provider and LangChain libraries remain runtime dependencies; shared
+Agenticrun code and TypeScript declarations are included in the release.
+
+Tracing delivery is timeout-bounded and does not reject the agent result when
+delivery fails. Heartbeats and recovery of abandoned traces are not implemented.
+
+## Release development
+
+From the repository root, `pnpm sdk:build` builds `packages/sdk/release` directly
+from source. `pnpm sdk:pack` rebuilds and creates the npm tarball in that directory.
+These commands leave workspace `dist` directories untouched and never publish.
+`pnpm sdk:verify` rebuilds, packs and installs the tarball in a temporary directory,
+then checks the public imports, TypeScript declarations and tracing with a mocked
+backend. It requires npm registry access and removes the temporary consumer afterward.
+The workspace package stays private; the generated release manifest contains
+only runtime dependencies and compiled public entrypoints.
+
+Version and license are maintained in `packages/sdk/package.json`. The initial
+version is an alpha; the prepared publish configuration uses the `alpha` tag.
+License: UNLICENSED, pending the owner's licensing decision.