@ailog/cli 0.2.3 → 0.3.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,12 @@
+ailog
+Copyright 2026 ailog contributors
+
+This product includes software derived from the AI SDK DevTools package
+(https://github.com/vercel/ai/tree/main/packages/devtools), licensed under
+the Apache License, Version 2.0.
+
+  Copyright 2024-2026 Vercel, Inc.
+
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0

package/README.md

@@ -1,33 +1,130 @@
-# ailog Dashboard CLI
+# ailog
 
-CLI tool to run the ailog LLM logging dashboard.
+Local devtools for inspecting LLM calls. Records `generateText` / `streamText` (or any provider you instrument by hand) to disk and serves it in a live web viewer.
 
-## Installation
+> Local development only. Throws if `NODE_ENV=production`.
+
+## Install
 
 ```bash
-npm install -g ailog
+bun add -D @ailog/cli
+# or
+npm install -D @ailog/cli
 ```
 
 ## Usage
 
-```bash
-# Start the dashboard server
-ailog start
+### AI SDK middleware
+
+```ts
+import { wrapLanguageModel } from 'ai';
+import { aiSdkMiddleware } from '@ailog/cli';
+
+const model = wrapLanguageModel({
+  middleware: aiSdkMiddleware(),
+  model: anthropic('claude-opus-4-7'),
+});
+```
+
+### Provider-agnostic logger
+
+For non-AI-SDK providers, record runs manually:
+
+```ts
+import { createLogger } from '@ailog/cli';
+
+const run = await createLogger({ functionId: 'chat' });
+const step = await run.step({
+  modelId: 'claude-opus-4-7',
+  provider: 'anthropic',
+  input: { messages },
+});
+try {
+  const res = await callAnthropic(messages);
+  await step.end({ output: res, usage: res.usage });
+} catch (err) {
+  await step.end({ error: err });
+  throw err;
+}
+```
+
+### Threads
+
+Tag a run with a `threadId` to group it with other runs from the same logical conversation / session / workflow. The viewer renders the id as a small `#thread-id` pill on each run card, and a `Thread` record (id, created_at, updated_at, run_count) is persisted in `.ailog/index.json` for future thread-list features.
+
+```ts
+await createLogger({
+  threadId: 'chat-42',
+  functionId: 'message',
+});
+```
+
+- `threadId` is honored only on the first writer that creates a given run (first-writer-wins, like `functionId` / `metadata`).
+- Runs without a `threadId` simply don't appear in any thread.
+
+### Metadata
 
-# Start with custom port
-ailog start --port 8080
+Attach arbitrary fields to a run. Child runs (subagents) inherit metadata automatically — shallow-merged, with `metadata: null` to opt out:
 
-# Start with custom hostname
-ailog start --hostname 127.0.0.1
+```ts
+await createLogger({
+  metadata: { userId: 'u_42', organizationId: 'o_lr' },
+});
 ```
 
-## Options
+Rendered as `key: value` pills on the run header.
+
+### Subagents (shared threadId)
+
+Each `aiSdkMiddleware` instance owns one Run automatically. To group orchestrator and subagent calls — each constructed with its own wrapped model — share a `threadId`. They show up side-by-side under the same Thread in the viewer.
+
+```ts
+import { aiSdkMiddleware } from '@ailog/cli';
+
+const orchestrator = wrapLanguageModel({
+  middleware: aiSdkMiddleware({
+    threadId: 'tokyo',
+    functionId: 'orchestrator',
+    metadata: { userId: '...' },
+  }),
+  model,
+});
+
+const tools = {
+  research: tool({
+    execute: async ({ question }) => {
+      const sub = wrapLanguageModel({
+        // Share only the threadId — each tool call gets its own Run in the same Thread.
+        middleware: aiSdkMiddleware({ threadId: 'tokyo', functionId: 'researcher' }),
+        model,
+      });
+      return { answer: (await generateText({ model: sub, prompt: question })).text };
+    },
+  }),
+};
+
+await generateText({ model: orchestrator, tools, ... });
+```
+
+Rules:
+- `threadId` is auto-generated (`auto-<short>`) when omitted, so every run still belongs to a Thread.
+- `metadata` lives on the Thread record (not the Run). First-writer-wins: only the call that creates the Thread sets it.
+- Run ids are always auto-generated; you can't reuse one across loggers. Share a Thread, not a Run.
+
+### Viewer
+
+```bash
+bunx ailog   # → http://localhost:4985  (override via AILOG_PORT)
+```
+
+## How it works
+
+```
+your code → middleware / createLogger → .ailog/{index, runs/*, blobs/*} → Hono API → React UI
+```
 
-| Option                      | Description         | Default   |
-| --------------------------- | ------------------- | --------- |
-| `-p, --port <port>`         | Port to listen on   | `9000`    |
-| `-H, --hostname <hostname>` | Hostname to bind to | `0.0.0.0` |
+Each step write touches only its run's small JSON file plus the index — never the whole history. Large `raw_*` fields are externalized into `.ailog/blobs/`. Aborted requests (Ctrl-C) close in-flight steps with `error: 'Request aborted'` before exit.
 
-## Requirements
+## License
 
-- Node.js 18 or higher
+Apache-2.0. Structure and viewer code derived from `@ai-sdk/devtools` (Apache-2.0). See `NOTICE` for attribution.

package/bin/cli.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { startViewer } from '../dist/viewer/server.js';
+
+const port = process.env.AILOG_PORT
+  ? parseInt(process.env.AILOG_PORT)
+  : 4985;
+
+startViewer(port);