@deepnote/cli 0.1.0

package/dist/index.cjs

@@ -0,0 +1,12 @@
+const require_cli = require('./cli-DwaGOOLX.cjs');
+
+exports.ExitCode = require_cli.ExitCode;
+exports.FileResolutionError = require_cli.FileResolutionError;
+exports.createProgram = require_cli.createProgram;
+exports.getOutputConfig = require_cli.getOutputConfig;
+exports.resetOutputConfig = require_cli.resetOutputConfig;
+exports.resolvePathToDeepnoteFile = require_cli.resolvePathToDeepnoteFile;
+exports.run = require_cli.run;
+exports.setOutputConfig = require_cli.setOutputConfig;
+exports.shouldDisableColor = require_cli.shouldDisableColor;
+exports.version = require_cli.version;

package/dist/index.d.cts

@@ -0,0 +1,113 @@
+import { Command } from "commander";
+
+//#region src/cli.d.ts
+
+/**
+ * Global CLI options that apply to all commands.
+ */
+interface GlobalOptions {
+  color: boolean;
+  debug: boolean;
+  quiet: boolean;
+}
+/**
+ * Creates and configures the main CLI program.
+ */
+declare function createProgram(): Command;
+/**
+ * Parses command line arguments and runs the CLI.
+ * This is the main entry point for the CLI.
+ */
+declare function run(argv?: string[]): void;
+//#endregion
+//#region src/exit-codes.d.ts
+/**
+ * Standard exit codes for the Deepnote CLI.
+ *
+ * These follow common Unix conventions:
+ * - 0: Success
+ * - 1: General errors
+ * - 2: Invalid usage (bad arguments, missing files, etc.)
+ *
+ * @see https://tldp.org/LDP/abs/html/exitcodes.html
+ */
+declare const ExitCode: {
+  /** Command completed successfully */
+  readonly Success: 0;
+  /** General error (runtime failures, unexpected errors) */
+  readonly Error: 1;
+  /** Invalid usage (bad arguments, invalid file type, file not found) */
+  readonly InvalidUsage: 2;
+};
+type ExitCode = (typeof ExitCode)[keyof typeof ExitCode];
+//#endregion
+//#region src/output.d.ts
+/**
+ * Global output configuration for the CLI.
+ * Controls color output, verbosity, and quiet mode.
+ */
+interface OutputConfig {
+  /** Whether to use colored output */
+  color: boolean;
+  /** Whether to show debug/verbose output */
+  debug: boolean;
+  /** Whether to suppress non-essential output */
+  quiet: boolean;
+}
+/**
+ * Get the current output configuration.
+ * Returns a copy to prevent external mutations from affecting internal state.
+ */
+declare function getOutputConfig(): Readonly<OutputConfig>;
+/**
+ * Update the output configuration.
+ */
+declare function setOutputConfig(config: Partial<OutputConfig>): void;
+/**
+ * Reset output configuration to defaults.
+ * Useful for testing.
+ */
+declare function resetOutputConfig(): void;
+/**
+ * Check if colors should be disabled based on environment.
+ * Respects NO_COLOR and FORCE_COLOR standards.
+ *
+ * @see https://no-color.org/
+ * @see https://force-color.org/
+ */
+declare function shouldDisableColor(): boolean;
+//#endregion
+//#region src/utils/file-resolver.d.ts
+/**
+ * Error thrown when file resolution fails (invalid path, wrong extension, etc.)
+ * This is a user input error, not a runtime error.
+ */
+declare class FileResolutionError extends Error {
+  constructor(message: string);
+}
+interface ResolvedFile {
+  absolutePath: string;
+}
+interface ResolveDeepnoteFileOptions {
+  /** Custom error message when no .deepnote files are found */
+  noFilesFoundMessage?: string;
+}
+/**
+ * Resolves and validates a .deepnote file path.
+ *
+ * Smart resolution behavior:
+ * - No path: finds first .deepnote file in current directory
+ * - Directory path: finds first .deepnote file in that directory
+ * - File path: validates it's a .deepnote file
+ *
+ * @param path - Optional path to a .deepnote file or directory (relative or absolute)
+ * @param options - Optional configuration
+ * @returns The resolved absolute path
+ * @throws FileResolutionError if no .deepnote file found or file is invalid
+ */
+declare function resolvePathToDeepnoteFile(path: string | undefined, options?: ResolveDeepnoteFileOptions): Promise<ResolvedFile>;
+//#endregion
+//#region src/version.d.ts
+declare const version: string;
+//#endregion
+export { ExitCode, type ExitCode as ExitCodeType, FileResolutionError, type GlobalOptions, type OutputConfig, createProgram, getOutputConfig, resetOutputConfig, resolvePathToDeepnoteFile, run, setOutputConfig, shouldDisableColor, version };

package/dist/index.d.ts

@@ -0,0 +1,113 @@
+import "chalk";
+import { Command } from "commander";
+
+//#region src/cli.d.ts
+/**
+ * Global CLI options that apply to all commands.
+ */
+interface GlobalOptions {
+  color: boolean;
+  debug: boolean;
+  quiet: boolean;
+}
+/**
+ * Creates and configures the main CLI program.
+ */
+declare function createProgram(): Command;
+/**
+ * Parses command line arguments and runs the CLI.
+ * This is the main entry point for the CLI.
+ */
+declare function run(argv?: string[]): void;
+//#endregion
+//#region src/exit-codes.d.ts
+/**
+ * Standard exit codes for the Deepnote CLI.
+ *
+ * These follow common Unix conventions:
+ * - 0: Success
+ * - 1: General errors
+ * - 2: Invalid usage (bad arguments, missing files, etc.)
+ *
+ * @see https://tldp.org/LDP/abs/html/exitcodes.html
+ */
+declare const ExitCode: {
+  /** Command completed successfully */
+  readonly Success: 0;
+  /** General error (runtime failures, unexpected errors) */
+  readonly Error: 1;
+  /** Invalid usage (bad arguments, invalid file type, file not found) */
+  readonly InvalidUsage: 2;
+};
+type ExitCode = (typeof ExitCode)[keyof typeof ExitCode];
+//#endregion
+//#region src/output.d.ts
+/**
+ * Global output configuration for the CLI.
+ * Controls color output, verbosity, and quiet mode.
+ */
+interface OutputConfig {
+  /** Whether to use colored output */
+  color: boolean;
+  /** Whether to show debug/verbose output */
+  debug: boolean;
+  /** Whether to suppress non-essential output */
+  quiet: boolean;
+}
+/**
+ * Get the current output configuration.
+ * Returns a copy to prevent external mutations from affecting internal state.
+ */
+declare function getOutputConfig(): Readonly<OutputConfig>;
+/**
+ * Update the output configuration.
+ */
+declare function setOutputConfig(config: Partial<OutputConfig>): void;
+/**
+ * Reset output configuration to defaults.
+ * Useful for testing.
+ */
+declare function resetOutputConfig(): void;
+/**
+ * Check if colors should be disabled based on environment.
+ * Respects NO_COLOR and FORCE_COLOR standards.
+ *
+ * @see https://no-color.org/
+ * @see https://force-color.org/
+ */
+declare function shouldDisableColor(): boolean;
+//#endregion
+//#region src/utils/file-resolver.d.ts
+/**
+ * Error thrown when file resolution fails (invalid path, wrong extension, etc.)
+ * This is a user input error, not a runtime error.
+ */
+declare class FileResolutionError extends Error {
+  constructor(message: string);
+}
+interface ResolvedFile {
+  absolutePath: string;
+}
+interface ResolveDeepnoteFileOptions {
+  /** Custom error message when no .deepnote files are found */
+  noFilesFoundMessage?: string;
+}
+/**
+ * Resolves and validates a .deepnote file path.
+ *
+ * Smart resolution behavior:
+ * - No path: finds first .deepnote file in current directory
+ * - Directory path: finds first .deepnote file in that directory
+ * - File path: validates it's a .deepnote file
+ *
+ * @param path - Optional path to a .deepnote file or directory (relative or absolute)
+ * @param options - Optional configuration
+ * @returns The resolved absolute path
+ * @throws FileResolutionError if no .deepnote file found or file is invalid
+ */
+declare function resolvePathToDeepnoteFile(path: string | undefined, options?: ResolveDeepnoteFileOptions): Promise<ResolvedFile>;
+//#endregion
+//#region src/version.d.ts
+declare const version: string;
+//#endregion
+export { ExitCode, type ExitCode as ExitCodeType, FileResolutionError, type GlobalOptions, type OutputConfig, createProgram, getOutputConfig, resetOutputConfig, resolvePathToDeepnoteFile, run, setOutputConfig, shouldDisableColor, version };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { a as resolvePathToDeepnoteFile, c as setOutputConfig, i as FileResolutionError, l as shouldDisableColor, n as run, o as getOutputConfig, r as version, s as resetOutputConfig, t as createProgram, u as ExitCode } from "./cli-BDKrMj8W.js";
+
+export { ExitCode, FileResolutionError, createProgram, getOutputConfig, resetOutputConfig, resolvePathToDeepnoteFile, run, setOutputConfig, shouldDisableColor, version };

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@deepnote/cli",
+  "version": "0.1.0",
+  "description": "Command-line interface for running Deepnote projects locally and on Deepnote Cloud",
+  "keywords": [
+    "cli",
+    "deepnote",
+    "notebook",
+    "data-science"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/deepnote/deepnote.git",
+    "directory": "packages/cli"
+  },
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "deepnote": "./dist/bin.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "package.json"
+  ],
+  "dependencies": {
+    "@shikijs/cli": "^3.21.0",
+    "@toon-format/toon": "^2.1.0",
+    "chalk": "^5.4.1",
+    "commander": "^14.0.2",
+    "diff": "^8.0.3",
+    "dotenv": "^17.2.3",
+    "ora": "^9.0.0",
+    "wrap-ansi": "^9.0.2",
+    "yaml": "^2.8.1",
+    "zod": "3.25.76",
+    "@deepnote/blocks": "4.0.0",
+    "@deepnote/database-integrations": "1.4.2",
+    "@deepnote/convert": "3.0.0",
+    "@deepnote/reactivity": "1.1.0",
+    "@deepnote/runtime-core": "0.1.0"
+  },
+  "devDependencies": {
+    "tsx": "^4.20.6",
+    "zod-to-json-schema": "^3.25.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsx src/bin.ts",
+    "test": "vitest",
+    "watch": "tsdown --watch"
+  }
+}