@axlsdk/studio 0.2.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Axl Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,196 @@
+# @axlsdk/studio
+
+Local development UI for debugging, testing, and iterating on [Axl](https://github.com/axl-sdk/axl) agents and workflows.
+
+## Installation
+
+```bash
+npm install -D @axlsdk/studio
+```
+
+Or run directly with npx (no install needed):
+
+```bash
+npx @axlsdk/studio
+```
+
+**Requirements:** Node.js 20+, an existing Axl project with `@axlsdk/axl` installed.
+
+## Quick Start
+
+### 1. Create a config file
+
+Studio needs an `axl.config.ts` that exports an `AxlRuntime` as the default export. Register your workflows, agents, and tools so Studio can discover them:
+
+```typescript
+// axl.config.ts
+import { AxlRuntime, agent, tool, workflow } from '@axlsdk/axl';
+import { z } from 'zod';
+
+const getWeather = tool({
+  name: 'get_weather',
+  description: 'Get weather for a city',
+  input: z.object({ city: z.string() }),
+  handler: async ({ city }) => ({ city, temp: 72, condition: 'sunny' }),
+});
+
+const assistant = agent({
+  name: 'assistant',
+  model: 'openai:gpt-4o',
+  system: 'You are a helpful assistant.',
+  tools: [getWeather],
+});
+
+const chat = workflow({
+  name: 'chat',
+  input: z.object({ message: z.string() }),
+  handler: async (ctx) => ctx.ask(assistant, ctx.input.message),
+});
+
+const runtime = new AxlRuntime();
+runtime.register(chat);
+runtime.registerAgent(assistant);
+runtime.registerTool(getWeather);
+
+export default runtime;
+```
+
+### 2. Start Studio
+
+```bash
+npx @axlsdk/studio --open
+```
+
+This loads your config, starts the server on `http://localhost:4400`, and opens the browser.
+
+## CLI Options
+
+```
+axl-studio [options]
+
+Options:
+  --port <number>    Server port (default: 4400)
+  --config <path>    Path to config file (default: ./axl.config.ts)
+  --open             Auto-open browser
+  -h, --help         Show help
+```
+
+## Panels
+
+### Agent Playground
+Chat with any registered agent in real-time. See streaming tokens, tool calls with expandable input/output, and multi-turn conversation history.
+
+### Workflow Runner
+Execute workflows with custom JSON input. View execution timelines showing each agent call, tool invocation, and cost.
+
+### Trace Explorer
+Waterfall visualization of execution traces. Filter by type, agent, or tool. View token counts, cost per step, and duration.
+
+### Cost Dashboard
+Track spending across agents, models, and workflows. Live cost updates via WebSocket. Per-agent and per-model breakdowns.
+
+### Memory Browser
+View and manage agent memory (session and global scope). Create, edit, and delete entries. Test semantic recall queries.
+
+### Session Manager
+Browse active sessions with conversation history. Replay sessions step by step. View handoff chains between agents.
+
+### Tool Inspector
+Browse all registered tools with their schemas rendered as forms. Test any tool directly with custom input and see the result.
+
+### Eval Runner
+Run evaluations from the UI. View per-item results with scores. Compare two eval runs side-by-side with regression/improvement detection. Requires `@axlsdk/eval` as an optional peer dependency.
+
+## What gets registered
+
+Studio discovers your project through the `AxlRuntime` instance. Use these methods to make things visible:
+
+| Method | What it exposes |
+|--------|----------------|
+| `runtime.register(workflow)` | Workflows (Workflow Runner, Playground) |
+| `runtime.registerAgent(agent)` | Agents (Playground agent picker) |
+| `runtime.registerTool(tool)` | Tools (Tool Inspector) |
+
+Workflows are required for execution. Agents and tools are optional but recommended — they power the Playground agent picker and Tool Inspector panels.
+
+## API Endpoints
+
+Studio exposes a REST API that the SPA consumes. You can also call these directly for scripting or testing.
+
+| Endpoint | Description |
+|----------|-------------|
+| `GET /api/health` | Server status, registered workflow/agent/tool counts |
+| `GET /api/workflows` | List all workflows with input/output schemas |
+| `GET /api/workflows/:name` | Workflow detail |
+| `POST /api/workflows/:name/execute` | Execute a workflow |
+| `GET /api/agents` | List all agents |
+| `GET /api/agents/:name` | Agent detail with config |
+| `GET /api/tools` | List all tools with JSON Schema |
+| `GET /api/tools/:name` | Tool detail |
+| `POST /api/tools/:name/test` | Test a tool with `{ input: {...} }` |
+| `GET /api/sessions` | List sessions |
+| `GET /api/executions` | List executions |
+| `GET /api/costs` | Aggregated cost data |
+| `GET /api/memory/:scope/:key` | Read memory entry |
+
+All endpoints return `{ ok: true, data: {...} }` on success or `{ ok: false, error: { code, message } }` on error.
+
+### WebSocket
+
+Single endpoint at `ws://localhost:4400/ws` with channel multiplexing:
+
+```json
+{ "type": "subscribe", "channel": "trace:*" }
+{ "type": "event", "channel": "trace:abc-123", "data": { ... } }
+```
+
+Channels: `execution:{id}`, `trace:{id}`, `trace:*`, `costs`, `decisions`.
+
+## Architecture
+
+```
+src/
+  cli.ts                  CLI entry — loads config, starts server
+  server/
+    index.ts              createServer() — Hono app composition
+    types.ts              API types, WebSocket message types
+    cost-aggregator.ts    Accumulates cost from trace events
+    middleware/
+      error-handler.ts    Axl errors → JSON error envelope
+    routes/               One file per resource (health, workflows, agents, tools, etc.)
+    ws/
+      handler.ts          WebSocket message routing
+      connection-manager.ts  Channel subscriptions + broadcast
+  client/
+    App.tsx               React SPA — sidebar + 8 panel routes
+    lib/
+      api.ts              Typed fetch wrappers for all endpoints
+      ws.ts               WebSocket client with channel subscriptions
+    panels/               One directory per panel
+```
+
+**Server:** Hono HTTP server wrapping the user's `AxlRuntime`. REST endpoints for CRUD, WebSocket for live streaming.
+
+**Client:** React 19 SPA with Tailwind CSS v4, TanStack Query, and react-router-dom. Pre-built at publish time and served as static assets.
+
+**CLI:** Loads the user's `.ts` config via `tsx`, validates the runtime, starts the server, and optionally opens the browser.
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build everything (client then server)
+pnpm --filter @axlsdk/studio build
+
+# Dev mode (Vite HMR + server watch)
+pnpm --filter @axlsdk/studio dev
+
+# Type check
+pnpm --filter @axlsdk/studio typecheck
+```
+
+## License
+
+Apache-2.0