lmnr-cli 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,75 @@
+
+
+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:
+
+    You must give any other recipients of the Work or Derivative Works a copy of this License; and
+    You must cause any modified files to carry prominent notices stating that You changed the files; and
+    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
+    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
+
+Include a copy of the Apache License, typically in a file called LICENSE, in your work, and consider also including a NOTICE file that references the License.
+
+To apply the Apache License to specific files in your work, attach the following boilerplate declaration, replacing the fields enclosed by brackets "[]" with your own identifying information. (Don't include the brackets!) Enclose the text in the appropriate comment syntax for the file format. We also recommend that you include a file or class name and description of purpose on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright 2024 LMNR AI, Inc.
+
+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,409 @@
+# lmnr-cli
+
+Language-agnostic CLI for Laminar AI rollout debugging.
+
+## Overview
+
+The Laminar CLI is a pure orchestrator that coordinates rollout debugging sessions between your code and the Laminar backend. It is designed to be completely language-agnostic, delegating language-specific execution to worker processes.
+
+## Installation
+
+```bash
+# Run directly with npx
+npx lmnr-cli@latest dev agent.ts
+
+# Or install globally
+npm install -g lmnr-cli
+lmnr-cli dev agent.ts
+```
+
+## Usage
+
+```bash
+lmnr-cli dev [file] [options]
+# OR
+lmnr-cli dev -m <python-module> [options]
+```
+
+### Options
+
+- `-m, --python-module <module>` - Python module path (e.g., `src.myfile`)
+- `--function <name>` - Specific function to serve (if multiple rollout functions found)
+- `--project-api-key <key>` - Project API key (or set `LMNR_PROJECT_API_KEY` env variable)
+- `--base-url <url>` - Base URL for the Laminar API (default: https://api.lmnr.ai)
+- `--port <port>` - Port for the Laminar API (default: 443)
+- `--grpc-port <port>` - Port for the Laminar gRPC backend (default: 8443)
+- `--frontend-port <port>` - Port for the Laminar frontend (default: 5667)
+- `--external-packages <packages...>` - [ADVANCED] Packages to pass as external to esbuild
+- `--dynamic-imports-to-skip <modules...>` - [ADVANCED] Dynamic imports to skip
+- `--command <command>` - [ADVANCED] Custom worker command (e.g., `python3`, `node`)
+- `--command-args <args...>` - [ADVANCED] Arguments for the custom command
+
+### Examples
+
+```bash
+# TypeScript
+npx lmnr-cli@latest dev agent.ts
+
+# JavaScript (extracts parameter names at runtime)
+npx lmnr-cli@latest dev agent.js
+
+# Python - Script mode
+npx lmnr-cli@latest dev agent.py
+
+# Python - Module mode
+npx lmnr-cli@latest dev -m src.agent
+```
+
+## Architecture
+
+The CLI orchestrates three components:
+
+1. **SSE Client**: Connects to Laminar backend and receives run events
+2. **Cache Server**: Local HTTP server (port 35667) that provides cached spans to workers
+3. **Worker Process**: Language-specific subprocess that executes your code
+
+```
+┌─────────────────┐
+│  Laminar API    │
+└────────┬────────┘
+         │ SSE
+         │
+┌────────▼────────┐      ┌──────────────┐
+│   CLI Process   │◄────►│ Cache Server │
+│  (Orchestrator) │      │  (HTTP:35667)│
+└────────┬────────┘      └──────▲───────┘
+         │                      │
+         │ spawn                │ HTTP
+         │                      │
+┌────────▼────────┐      ┌──────┴───────┐
+│ Worker Process  │─────►│  Your Code   │
+│ (TS/Python/etc) │      │  (agent.ts)  │
+└─────────────────┘      └──────────────┘
+```
+
+## Worker Protocol
+
+The CLI communicates with workers using a simple JSON protocol over stdin/stdout.
+
+### Input (via stdin)
+
+The CLI sends a single JSON line to the worker's stdin containing the configuration:
+
+```typescript
+{
+  filePath: string;              // Path to the file to execute
+  functionName?: string;         // Specific function to run
+  args: Record<string, any> | any[]; // Arguments for the function
+  env: Record<string, string>;   // Environment variables
+  cacheServerPort: number;       // Port of the cache server
+  baseUrl: string;               // Laminar API base URL
+  projectApiKey?: string;        // Project API key
+  httpPort: number;              // HTTP port for Laminar API
+  grpcPort: number;              // gRPC port for Laminar API
+  externalPackages?: string[];   // External packages (TS-specific)
+  dynamicImportsToSkip?: string[]; // Dynamic imports to skip (TS-specific)
+}
+```
+
+### Output (via stdout)
+
+Workers send messages prefixed with `__LMNR_WORKER__:` to stdout:
+
+#### Log Message
+```typescript
+{
+  type: 'log';
+  level: 'info' | 'debug' | 'error' | 'warn';
+  message: string;
+}
+```
+
+#### Result Message
+```typescript
+{
+  type: 'result';
+  data: any;  // Function return value
+}
+```
+
+#### Error Message
+```typescript
+{
+  type: 'error';
+  error: string;    // Error message
+  stack?: string;   // Stack trace
+}
+```
+
+### User Output
+
+Any stdout without the `__LMNR_WORKER__:` prefix is considered user output (e.g., `console.log()`) and passed through transparently.
+
+### Environment Variables
+
+The CLI sets these environment variables for the worker:
+
+- `LMNR_ROLLOUT_SESSION_ID`: Session ID for this rollout run
+- `LMNR_ROLLOUT_STATE_SERVER_ADDRESS`: Cache server URL (http://localhost:35667)
+
+### Cache Server API
+
+Workers can query the cache server for cached spans:
+
+**Endpoint**: `POST /cached`
+
+**Request**:
+```json
+{
+  "path": "string",   // Span path
+  "index": number     // Span index
+}
+```
+
+**Response**:
+```json
+{
+  "span": {
+    "name": "string",
+    "input": "string",      // JSON string
+    "output": "string",     // JSON string
+    "attributes": {}        // Parsed attributes
+  },
+  "pathToCount": {
+    "path1": 5,
+    "path2": 3
+  },
+  "overrides": {
+    "spanName": {
+      "system": "string or array",
+      "tools": [{
+        "name": "string",
+        "description": "string",
+        "parameters": {}
+      }]
+    }
+  }
+}
+```
+
+## Implementing a Worker
+
+To support a new language, implement a worker that:
+
+1. Reads JSON configuration from stdin
+2. Sets environment variables from `config.env`
+3. Loads and executes the specified function
+4. Initializes your SDK's tracing (reads `LMNR_ROLLOUT_STATE_SERVER_ADDRESS`)
+5. Sends protocol messages to stdout (prefixed with `__LMNR_WORKER__:`)
+6. Exits with code 0 on success, non-zero on failure
+
+### Example: TypeScript Worker
+
+The TypeScript worker is included in `@lmnr-ai/lmnr`:
+
+```typescript
+// Read config from stdin
+const config = JSON.parse(await readStdin());
+
+// Set environment variables
+for (const [key, value] of Object.entries(config.env)) {
+  process.env[key] = value;
+}
+
+// Initialize SDK
+Laminar.initialize({
+  baseUrl: config.baseUrl,
+  projectApiKey: config.projectApiKey,
+  // ...
+});
+
+// Load and execute function
+const module = require(config.filePath);
+const result = await module[config.functionName](...config.args);
+
+// Send result
+sendMessage({ type: 'result', data: result });
+
+// Exit successfully
+process.exit(0);
+```
+
+### Example: Python Worker (Future)
+
+```python
+# python -m lmnr.cli.worker
+
+import json
+import sys
+import os
+
+# Read config from stdin
+config = json.loads(sys.stdin.readline())
+
+# Set environment variables
+for key, value in config['env'].items():
+    os.environ[key] = value
+
+# Initialize SDK
+import lmnr
+lmnr.initialize(
+    base_url=config['baseUrl'],
+    project_api_key=config['projectApiKey'],
+)
+
+# Load and execute function
+module = __import__(config['filePath'])
+result = getattr(module, config['functionName'])(*config['args'])
+
+# Send result
+send_message({'type': 'result', 'data': result})
+
+# Exit successfully
+sys.exit(0)
+```
+
+## Default Worker Resolution
+
+The CLI automatically resolves workers based on file extension:
+
+| Extension | Worker Command |
+|-----------|----------------|
+| `.ts`, `.tsx` | `node @lmnr-ai/lmnr/dist/cli/worker.cjs` |
+| `.js`, `.mjs`, `.cjs` | `node @lmnr-ai/lmnr/dist/cli/worker.cjs` |
+| `.py` | `python3 -m lmnr.cli.worker` |
+
+Custom workers can be specified with `--command` and `--command-args`.
+
+## Python Language Support
+
+### Metadata Discovery
+
+The CLI needs to discover function metadata (name and parameters) to provide a rich UI experience. For Python files, this is done by calling the `lmnr` Python package.
+
+#### Required Command Interface
+
+The Python `lmnr` package must implement the following CLI command:
+
+```bash
+lmnr discover --file <filepath> [--function <name>]
+# OR
+lmnr discover --module <module> [--function <name>]
+```
+
+**Arguments:**
+
+- `--file <filepath>`: Path to the Python file containing rollout functions (script mode)
+- `--module <module>`: Python module path like `src.myfile` (module mode)
+- `--function <name>`: (Optional) Specific function name to discover. If omitted, discover all.
+
+**Note:** Exactly one of `--file` or `--module` must be provided.
+
+**Output Format (JSON to stdout):**
+
+```json
+{
+  "name": "my_agent",
+  "params": [
+    {
+      "name": "query",
+      "type": "string"
+    },
+    {
+      "name": "max_tokens",
+      "type": "number"
+    }
+  ]
+}
+```
+
+**Exit Codes:**
+
+- `0`: Success
+- Non-zero: Error (stderr contains error message)
+
+#### Python Execution Modes
+
+Python code can be executed in two modes, affecting how imports work:
+
+**Script Mode (default):**
+
+```bash
+npx lmnr-cli dev src/myfile.py
+# Internally executes as: python src/myfile.py
+# Discovery uses: lmnr discover --file src/myfile.py
+```
+
+- Works with relative imports: `from .utils import helper`
+- File is executed as a script
+- Best for standalone files and simple packages
+
+**Module Mode:**
+
+```bash
+npx lmnr-cli dev -m src.myfile
+# Internally executes as: python -m src.myfile
+# Discovery uses: lmnr discover --module src.myfile
+```
+
+- Requires absolute imports: `from src.utils import helper`
+- Module is executed via Python's `-m` flag
+- Best for packages with complex import structures
+- Requires proper `__init__.py` files in package directories
+
+**Examples:**
+
+```bash
+# Script mode - use file path with relative imports
+npx lmnr-cli dev agents/customer_support.py
+
+# Module mode - use module syntax with absolute imports
+npx lmnr-cli dev -m agents.customer_support
+
+# Specify a particular function
+npx lmnr-cli dev -m agents.customer_support --function run_agent
+```
+
+### Python Worker Requirements
+
+The Python `lmnr` package must implement a worker that executes rollout functions:
+
+```bash
+python -m lmnr.cli.worker
+```
+
+The worker should:
+
+1. Read JSON configuration from stdin containing either `filePath` (script mode) or `modulePath` (module mode)
+2. Set environment variables from config
+3. Initialize the `lmnr` SDK
+4. Load and execute the specified function based on the mode
+5. Send protocol messages to stdout (see [Worker Protocol](#worker-protocol))
+6. Exit with appropriate code
+
+**Worker Configuration:**
+
+The CLI will pass either:
+- `filePath`: Path to Python file (script mode)
+- `modulePath`: Python module path (module mode)
+
+The worker must detect which field is present and execute accordingly.
+
+See the [Worker Protocol](#worker-protocol) section for detailed communication protocol.
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build
+pnpm build
+
+# Run locally
+node dist/index.cjs dev examples/agent.ts
+```
+
+## License
+
+Apache-2.0