@deepnote/cli 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [2025] [Deepnote 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,387 @@
+# @deepnote/cli
+
+Command-line interface for running Deepnote projects locally and on Deepnote Cloud.
+
+> **Note:** This project is under active development and is not ready for production use. Expect breaking changes.
+
+## Installation
+
+```bash
+npm install -g @deepnote/cli
+# or
+pnpm add -g @deepnote/cli
+# or
+yarn global add @deepnote/cli
+```
+
+## Quick Start
+
+```bash
+# Show help
+deepnote --help
+
+# Show version
+deepnote --version
+
+# Inspect a .deepnote file
+deepnote inspect path/to/file.deepnote
+
+# Inspect with JSON output (for scripting)
+deepnote inspect path/to/file.deepnote --output json
+
+# Inspect with TOON output (for LLMs, 30-60% fewer tokens)
+deepnote inspect path/to/file.deepnote --output toon
+
+# Validate a .deepnote file
+deepnote validate path/to/file.deepnote
+
+# Run a project/notebook file (.deepnote, .ipynb, .py, .qmd)
+deepnote run path/to/file.deepnote
+```
+
+## Commands
+
+### `inspect [path]`
+
+Inspect and display metadata from a `.deepnote` file.
+Path is optional: when omitted, the CLI discovers the first `.deepnote` file in the current directory.
+
+```bash
+deepnote inspect my-project.deepnote
+```
+
+**Output includes:**
+
+- File path and project name
+- Project ID and file format version
+- Creation, modification, and export timestamps
+- Number of notebooks and blocks
+- List of notebooks with their block counts
+
+**Options:**
+
+| Option               | Description                             | Default |
+| -------------------- | --------------------------------------- | ------- |
+| `-o, --output <fmt>` | Output format: `json`, `toon`, or `llm` | text    |
+
+**Examples:**
+
+```bash
+# Basic inspection
+deepnote inspect my-project.deepnote
+
+# Inspect first .deepnote file in current directory
+deepnote inspect
+
+# JSON output for scripting
+deepnote inspect my-project.deepnote --output json
+
+# TOON output for LLM consumption (30-60% fewer tokens)
+deepnote inspect my-project.deepnote --output toon
+
+# Use with jq to extract specific fields
+deepnote inspect my-project.deepnote --output json | jq '.project.name'
+```
+
+### `run [path]`
+
+Run a project/notebook file locally. Supported formats: `.deepnote`, `.ipynb`, `.py`, `.qmd`.
+Path is optional: when omitted, the CLI discovers the first `.deepnote` file in the current directory.
+
+```bash
+deepnote run my-project.deepnote
+```
+
+**Options:**
+
+| Option                  | Description                                               | Default        |
+| ----------------------- | --------------------------------------------------------- | -------------- |
+| `--python <path>`       | Path to Python interpreter or virtual environment         | auto-detected  |
+| `--cwd <path>`          | Working directory for execution                           | file directory |
+| `--notebook <name>`     | Run only the specified notebook                           | all notebooks  |
+| `--block <id>`          | Run only the specified block                              | all blocks     |
+| `-i, --input <key=val>` | Set input variable value (can be repeated)                |                |
+| `--list-inputs`         | List input variables without running                      | `false`        |
+| `-o, --output <fmt>`    | Output format: `json`, `toon`, or `llm`                   | text           |
+| `--dry-run`             | Show execution plan without running                       | `false`        |
+| `--top`                 | Display resource usage (CPU/memory) during execution      | `false`        |
+| `--profile`             | Show per-block timing and memory summary                  | `false`        |
+| `--open`                | Open project in Deepnote Cloud after successful execution | `false`        |
+| `--context`             | Include analysis context in machine-readable output       | `false`        |
+
+**Examples:**
+
+```bash
+# Run all notebooks
+deepnote run my-project.deepnote
+
+# Run a Jupyter notebook directly (auto-converted)
+deepnote run notebook.ipynb
+
+# Run with a specific Python virtual environment
+deepnote run my-project.deepnote --python path/to/venv
+
+# Run only a specific notebook
+deepnote run my-project.deepnote --notebook "Data Analysis"
+
+# Output results as JSON for CI/CD pipelines
+deepnote run my-project.deepnote --output json
+
+# Output results as TOON for LLM consumption
+deepnote run my-project.deepnote --output toon
+```
+
+### `validate <path>`
+
+Validate a `.deepnote` file against the schema.
+
+```bash
+deepnote validate my-project.deepnote
+```
+
+**Options:**
+
+| Option               | Description                    | Default |
+| -------------------- | ------------------------------ | ------- |
+| `-o, --output <fmt>` | Output format: `json` or `llm` | text    |
+
+**Examples:**
+
+```bash
+# Validate a file
+deepnote validate my-project.deepnote
+
+# JSON output for CI/CD pipelines
+deepnote validate my-project.deepnote --output json
+```
+
+### `completion <shell>`
+
+Generate shell completion scripts for tab completion.
+
+**Supported shells:** `bash`, `zsh`, `fish`
+
+**Installation:**
+
+```bash
+# Bash (add to ~/.bashrc or ~/.bash_profile)
+deepnote completion bash >> ~/.bashrc
+source ~/.bashrc
+
+# Zsh (add to ~/.zshrc)
+deepnote completion zsh >> ~/.zshrc
+source ~/.zshrc
+
+# Fish (save to completions directory)
+deepnote completion fish > ~/.config/fish/completions/deepnote.fish
+```
+
+## Global Options
+
+These options work with all commands:
+
+| Option          | Description                                        |
+| --------------- | -------------------------------------------------- |
+| `-h, --help`    | Display help information                           |
+| `-v, --version` | Display the CLI version                            |
+| `--no-color`    | Disable colored output                             |
+| `--debug`       | Show debug information for troubleshooting         |
+| `-q, --quiet`   | Suppress non-essential output (errors still shown) |
+
+## Environment Variables
+
+| Variable      | Description                                |
+| ------------- | ------------------------------------------ |
+| `NO_COLOR`    | Set to any value to disable colored output |
+| `FORCE_COLOR` | Set to `1` to force colors, `0` to disable |
+
+The CLI follows the [NO_COLOR](https://no-color.org/) and [FORCE_COLOR](https://force-color.org/) standards.
+
+## Exit Codes
+
+The CLI uses standard exit codes for scripting:
+
+| Code | Name          | Description                                   |
+| ---- | ------------- | --------------------------------------------- |
+| `0`  | Success       | Command completed successfully                |
+| `1`  | Error         | General error (runtime failures)              |
+| `2`  | Invalid Usage | Invalid arguments, file not found, wrong type |
+
+**Example usage in scripts:**
+
+```bash
+#!/bin/bash
+if deepnote inspect project.deepnote --output json > /dev/null 2>&1; then
+    echo "Valid .deepnote file"
+else
+    exit_code=$?
+    if [ $exit_code -eq 2 ]; then
+        echo "Invalid file or arguments"
+    else
+        echo "Unexpected error"
+    fi
+fi
+```
+
+## Output Formats
+
+The CLI supports output formats via the `-o, --output` option:
+
+| Format | Description                                                                             |
+| ------ | --------------------------------------------------------------------------------------- |
+| `json` | Standard JSON format for scripting and CI/CD pipelines                                  |
+| `toon` | [TOON format](https://toonformat.dev/) - LLM-optimized, 30-60% fewer tokens             |
+| `llm`  | Alias to the best LLM format for each command (`toon` when available, otherwise `json`) |
+
+## JSON Output Schema
+
+### `inspect --output json`
+
+```typescript
+interface InspectOutput {
+  success: true;
+  path: string;
+  project: {
+    name: string;
+    id: string;
+  };
+  version: string;
+  metadata: {
+    createdAt: string;
+    modifiedAt: string | null;
+    exportedAt: string | null;
+  };
+  statistics: {
+    notebookCount: number;
+    totalBlocks: number;
+  };
+  notebooks: Array<{
+    name: string;
+    blockCount: number;
+    isModule: boolean;
+  }>;
+}
+
+// On error:
+interface InspectError {
+  success: false;
+  error: string;
+}
+```
+
+### `run --output json`
+
+```typescript
+interface RunOutput {
+  success: boolean;
+  path: string;
+  executedBlocks: number;
+  totalBlocks: number;
+  failedBlocks: number;
+  totalDurationMs: number;
+  blocks: Array<{
+    id: string;
+    type: string;
+    label: string;
+    success: boolean;
+    durationMs: number;
+    outputs: Array<{
+      output_type: "stream" | "execute_result" | "display_data" | "error";
+      // For stream outputs:
+      name?: "stdout" | "stderr";
+      text?: string;
+      // For execute_result/display_data:
+      data?: Record<string, unknown>;
+      // For error outputs:
+      ename?: string;
+      evalue?: string;
+      traceback?: string[];
+    }>;
+    error?: string;
+  }>;
+}
+
+// On error before execution starts:
+interface RunError {
+  success: false;
+  error: string;
+}
+```
+
+### `validate --output json`
+
+```typescript
+// When validation runs (file found and readable):
+interface ValidationResult {
+  success: true;
+  path: string;
+  valid: boolean;
+  issues: Array<{
+    path: string; // JSON path to the invalid field (e.g., "notebooks.0.blocks.1")
+    message: string;
+    code: string; // Zod error code (e.g., "invalid_type", "unrecognized_keys")
+  }>;
+}
+
+// On error (file not found, resolution error, or runtime failure):
+interface ValidationError {
+  success: false;
+  error: string;
+}
+```
+
+The `success` field indicates whether the command completed:
+
+- `success: true` - validation ran, check `valid` for the result
+- `success: false` - operational error (file not found, etc.)
+
+## Programmatic Usage
+
+The CLI can also be used programmatically:
+
+```typescript
+import { createProgram, run, ExitCode } from "@deepnote/cli";
+
+// Run with custom arguments
+run(["node", "deepnote", "inspect", "project.deepnote"]);
+
+// Or create and configure the program manually
+const program = createProgram();
+program.parse([
+  "node",
+  "deepnote",
+  "inspect",
+  "project.deepnote",
+  "--output",
+  "json",
+]);
+```
+
+## Error Messages
+
+The CLI provides helpful error messages with suggestions:
+
+```bash
+$ deepnote inspect missing-file.deepnote
+# Error: File not found: /path/to/missing-file.deepnote
+#
+# Did you mean?
+#   - my-project.deepnote
+#   - another-project.deepnote
+
+$ deepnote inspect notebook.ipynb
+# Error: Unsupported file type: .ipynb
+#
+# Jupyter notebooks (.ipynb) are not directly supported.
+# Use the @deepnote/convert package to convert to .deepnote format.
+```
+
+## Related Packages
+
+- [`@deepnote/blocks`](../blocks) - Core package for working with Deepnote blocks
+- [`@deepnote/convert`](../convert) - Convert between Jupyter and Deepnote formats
+- [`@deepnote/runtime-core`](../runtime-core) - Runtime engine for executing notebooks
+
+## License
+
+Apache-2.0

package/dist/bin.cjs

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+const require_cli = require('./cli-DwaGOOLX.cjs');
+
+//#region src/bin.ts
+require_cli.run();
+
+//#endregion

package/dist/bin.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/bin.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/bin.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { n as run } from "./cli-BDKrMj8W.js";
+
+//#region src/bin.ts
+run();
+
+//#endregion
+export {  };