@onkernel/cli 0.0.2 → 0.1.3

package/README.md

@@ -1,15 +1,112 @@
-# cli
+# Kernel CLI
 
-To install dependencies:
+A command-line tool for deploying and invoking Kernel applications.
+
+## Installation
 
 ```bash
-bun install
+brew tap onkernel/homebrew-tap
+brew install kernel
 ```
 
-To run:
+## Development Prerequisites
+
+Install the following tools:
+
+- Go 1.22+ ( https://go.dev/doc/install )
+- [Goreleaser](https://goreleaser.com/install/)
+- [chglog](https://github.com/goreleaser/chglog)
+
+Compile the CLI:
+
+```bash
+make build   # compiles the binary to ./bin/kernel
+```
+
+Run the CLI:
+
+```bash
+./bin/kernel --help
+```
+
+## Development workflow
+
+Useful make targets:
+
+- `make build` – compile the project to `./bin/kernel`
+- `make test` – execute unit tests
+- `make lint` – run the linter (requires `golangci-lint`)
+- `make changelog` – generate/update the `CHANGELOG.md` file using **chglog**
+- `make release` – create a release using **goreleaser** (builds archives, homebrew formula, etc. See below)
+
+### Releasing a new version
+
+Prerequisites:
+
+- Make sure you have `goreleaser` _pro_ installed via `brew install goreleaser/tap/goreleaser-pro`. You will need a license key (in 1pw), and then `export GORELEASER_KEY=<the key>`.
+
+- Grab the NPM token for our org (in 1pw) and run `npm config set '//registry.npmjs.org/:_authToken'=<the token>`
+
+- export a `GITHUB_TOKEN` with repo and write:packages permissions: https://github.com/settings/tokens/new?scopes=repo,write:packages.
+
+- Make sure you are logged in to the prod AWS account with `aws sso login --sso-session=kernel` + `export AWS_PROFILE=kernel-prod`. This is necessary to publish releases to S3.
+
+On main, run:
 
 ```bash
-bun run index.ts
+make release-dry-run
 ```
 
-This project was created using `bun init` in bun v1.2.9. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+This will check that everything is working, but not actually release anything.
+You should see one error about there not being a git tag, and that's fine.
+
+To actually release, run:
+
+```bash
+export VERSION=0.1.1
+git tag -a cli/v$VERSION -m "Bugfixes"
+git push origin cli/v$VERSION
+make release
+```
+
+### Environment variables
+
+The CLI requires a Kernel API key to interact with the platform:
+
+```bash
+export KERNEL_API_KEY=your_api_key
+```
+
+### Releasing a new version
+
+1. Update the changelog:
+
+   ```bash
+   make changelog
+   ```
+
+2. Tag the release (e.g. `v1.0.0`) and push the tag:
+
+   ```bash
+   git tag cli/v0.1.0
+   git push origin cli/v0.1.0
+   ```
+
+3. Run `make release` – **goreleaser** will:
+
+   - Build binaries for macOS (arm64/amd64), Linux and Windows
+   - Create a GitHub release upload archives
+   - Publish/commit the Homebrew formula to the `onkernel/homebrew-tap` repository
+
+## Directory structure
+
+```
+packages/cli
+├── cmd/          # cobra commands (root, deploy, invoke, …)
+│   └── kernel/
+│       └── main.go
+├── pkg/          # reusable helpers (zip util, etc.)
+├── .goreleaser.yaml
+├── Makefile
+└── README.md
+```

package/install.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+// This file was generated by GoReleaser. DO NOT EDIT.
+
+const { install } = require("./lib.js");
+install();

package/lib.js

@@ -0,0 +1,175 @@
+// This file was generated by GoReleaser. DO NOT EDIT.
+const { archives } = require("./package.json");
+const fs = require("fs");
+const crypto = require("crypto");
+const path = require("path");
+const JSZip = require("jszip");
+const tar = require("tar");
+const axios = require("axios");
+const { spawnSync } = require("child_process");
+
+const getArchive = () => {
+	let target = `${process.platform}-${process.arch}`;
+	const archive = archives[target];
+	if (!archive) {
+		throw new Error(`No archive available for ${target}`);
+	}
+	return archive;
+};
+
+const binDir = path.join(__dirname, "bin");
+
+async function extractTar(tarPath, binaries, dir) {
+	try {
+		await tar.x({
+			file: tarPath,
+			cwd: dir,
+			filter: (path) => binaries.includes(path),
+		});
+		console.log(`Successfully extracted binaries to "${dir}"`);
+	} catch (err) {
+		throw new Error(`Extraction failed: ${err.message}`);
+	}
+}
+
+async function extractZip(zipPath, binaries, dir) {
+	try {
+		const zipData = fs.readFileSync(zipPath);
+		const zip = await JSZip.loadAsync(zipData);
+		for (const binary of binaries) {
+			if (!zip.files[binary]) {
+				throw new Error(
+					`Error: ${binary} does not exist in ${zipPath}`,
+				);
+			}
+
+			const content = await zip.files[binary].async("nodebuffer");
+			if (!fs.existsSync(dir)) {
+				fs.mkdirSync(dir, { recursive: true });
+			}
+			const file = path.join(dir, binary);
+			fs.writeFileSync(file, content);
+			fs.chmodSync(file, "755");
+			console.log(`Successfully extracted "${binary}" to "${dir}"`);
+		}
+	} catch (err) {
+		throw new Error(`Extraction failed: ${err.message}`);
+	}
+}
+
+const run = async (bin) => {
+	await install();
+	if (process.platform === "win32") {
+		bin += ".exe";
+	}
+	const [, , ...args] = process.argv;
+	let result = spawnSync(path.join(binDir, bin), args, {
+		cwd: process.cwd(),
+		stdio: "inherit",
+	});
+	if (result.error) {
+		console.error(result.error);
+	}
+	return result.status;
+};
+
+const install = async () => {
+	try {
+		let archive = getArchive();
+		if (await exists(archive)) {
+			return;
+		}
+		let tmp = fs.mkdtempSync("archive-");
+		let archivePath = path.join(tmp, archive.name);
+		await download(archive.url, archivePath);
+		verify(archivePath, archive.checksum);
+
+		if (!fs.existsSync(binDir)) {
+			fs.mkdirSync(binDir);
+		}
+		switch (archive.format) {
+			case "binary":
+				const bin = path.join(binDir, archive.bins[0]);
+				fs.copyFileSync(archivePath, bin);
+				fs.chmodSync(bin, 0o755);
+				return;
+			case "zip":
+				return extractZip(archivePath, archive.bins, binDir);
+			case "tar":
+			case "tar.gz":
+			case "tgz":
+				return extractTar(archivePath, archive.bins, binDir);
+			case "tar.zst":
+			case "tzst":
+			case "tar.xz":
+			case "txz":
+			default:
+				throw new Error(`unsupported format: ${archive.format}`);
+		}
+	} catch (err) {
+		throw new Error(`Installation failed: ${err.message}`);
+	}
+};
+
+const verify = (filename, checksum) => {
+	if (checksum.algorithm == "" || checksum.digest == "") {
+		console.warn("Warning: No checksum provided for verification");
+		return;
+	}
+	let digest = crypto
+		.createHash(checksum.algorithm)
+		.update(fs.readFileSync(filename))
+		.digest("hex");
+	if (digest != checksum.digest) {
+		throw new Error(
+			`${filename}: ${checksum.algorithm} does not match, expected ${checksum.digest}, got ${digest}`,
+		);
+	}
+};
+
+const download = async (url, filename) => {
+	try {
+		console.log(`Downloading ${url} to ${filename}...`);
+		const dir = path.dirname(filename);
+		if (!fs.existsSync(dir)) {
+			fs.mkdirSync(dir, { recursive: true });
+		}
+
+		const response = await axios({
+			method: "GET",
+			url: url,
+			responseType: "stream",
+			timeout: 300000, // 5min
+		});
+
+		const writer = fs.createWriteStream(filename);
+		response.data.pipe(writer);
+
+		return new Promise((resolve, reject) => {
+			writer.on("finish", () => {
+				console.log(`Download complete: ${filename}`);
+				resolve(dir);
+			});
+
+			writer.on("error", (err) => {
+				console.error(`Error writing file: ${err.message}`);
+				reject(err);
+			});
+		});
+	} catch (err) {
+		throw new Error(`Download failed: ${err.message}`);
+	}
+};
+
+function exists(archive) {
+	if (!fs.existsSync(binDir)) {
+		return false;
+	}
+	return archive.bins.every((bin) => fs.existsSync(path.join(binDir, bin)));
+}
+
+module.exports = {
+	install,
+	run,
+	getArchive,
+};

package/package.json

@@ -1,54 +1,108 @@
 {
   "name": "@onkernel/cli",
-  "version": "0.0.2",
-  "description": "Kernel CLI",
-  "type": "module",
-  "module": "index.ts",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "bin": {
-    "kernel": "./dist/index.js"
-  },
-  "files": [
-    "dist"
-  ],
+  "version": "0.1.3",
+  "description": "CLI for Kernel",
   "scripts": {
-    "build": "tsup --config tsup.config.js"
+    "postinstall": "node install.js",
+    "run": "node run-kernel.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://onkernel-public.s3.us-east-1.amazonaws.com/"
   },
   "keywords": [
     "kernel",
     "cli",
-    "ai",
-    "llm",
-    "llms",
-    "agent",
-    "agents",
-    "dev",
-    "development",
-    "deploy",
-    "deployment",
-    "build",
-    "workflow",
-    "typescript",
-    "command-line",
-    "devtools"
+    "browsers",
+    "automation",
+    "ai"
   ],
-  "author": "",
+  "author": "Rafael Garcia \u003craf@onkernel.com\u003e",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/onkernel/kernel/issues"
+  },
+  "homepage": "https://docs.onkernel.com",
+  "bin": {
+    "kernel": "run-kernel.js"
+  },
   "dependencies": {
-    "@onkernel/sdk": "0.1.0-alpha.9",
-    "@types/archiver": "^6.0.3",
-    "@types/ignore-walk": "^4.0.3",
-    "archiver": "^7.0.1",
-    "chalk": "^5.4.1",
-    "commander": "^13.1.0",
-    "fs-extra": "^11.3.0",
-    "ignore-walk": "^7.0.0",
-    "tmp": "^0.2.3",
-    "type-fest": "^4.40.1"
+    "axios": "^1.8.2",
+    "jszip": "^3.10.1",
+    "tar": "^7.4.3"
   },
-  "devDependencies": {
-    "@types/fs-extra": "^11.0.4",
-    "@types/tmp": "^0.2.6",
-    "tsup": "^8.4.0"
+  "archives": {
+    "darwin-arm64": {
+      "name": "kernel_0.1.3_darwin_arm64.tar.gz",
+      "url": "https://github.com/onkernel/kernel/releases/download/cli%2Fv0.1.3/kernel_0.1.3_darwin_arm64.tar.gz",
+      "bins": [
+        "kernel"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "d703b23c7e536c43dbc18b32eb0f87d61b0586bf4bbabb509cee0c7899bfc29e"
+      }
+    },
+    "darwin-x64": {
+      "name": "kernel_0.1.3_darwin_amd64.tar.gz",
+      "url": "https://github.com/onkernel/kernel/releases/download/cli%2Fv0.1.3/kernel_0.1.3_darwin_amd64.tar.gz",
+      "bins": [
+        "kernel"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "0af126117f591cedbfcd60dae8ff4a12dd2c3dcbb12e54594059d448d351a906"
+      }
+    },
+    "linux-arm64": {
+      "name": "kernel_0.1.3_linux_arm64.tar.gz",
+      "url": "https://github.com/onkernel/kernel/releases/download/cli%2Fv0.1.3/kernel_0.1.3_linux_arm64.tar.gz",
+      "bins": [
+        "kernel"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "8b50e00fd9f98ef3333081c916f392d3646b1ab214858daf6d0faa08e1223c03"
+      }
+    },
+    "linux-x64": {
+      "name": "kernel_0.1.3_linux_amd64.tar.gz",
+      "url": "https://github.com/onkernel/kernel/releases/download/cli%2Fv0.1.3/kernel_0.1.3_linux_amd64.tar.gz",
+      "bins": [
+        "kernel"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "a23d3c552729de53d7321ecccc73d8108c1c7af850a917f4976ba81a59368b06"
+      }
+    },
+    "win32-arm64": {
+      "name": "kernel_0.1.3_windows_arm64.tar.gz",
+      "url": "https://github.com/onkernel/kernel/releases/download/cli%2Fv0.1.3/kernel_0.1.3_windows_arm64.tar.gz",
+      "bins": [
+        "kernel.exe"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "1ab255f78eae35d0e2a368ca04c99695933e7eacd19208ab53f4f1dbfa3323dd"
+      }
+    },
+    "win32-x64": {
+      "name": "kernel_0.1.3_windows_amd64.tar.gz",
+      "url": "https://github.com/onkernel/kernel/releases/download/cli%2Fv0.1.3/kernel_0.1.3_windows_amd64.tar.gz",
+      "bins": [
+        "kernel.exe"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "298beb9c14eacb53567debb23ea52e54f2098e1dd676f58c127e77a66869d78c"
+      }
+    }
   }
-}
+}

package/run-kernel.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+// This file was generated by GoReleaser. DO NOT EDIT.
+
+const { run } = require("./lib.js");
+run("kernel");

package/dist/index.d.ts

@@ -1 +0,0 @@
-#!/usr/bin/env bun

package/dist/index.js

@@ -1,150 +0,0 @@
-#!/usr/bin/env bun
-import { Kernel } from '@onkernel/sdk';
-import chalk from 'chalk';
-import { Command } from 'commander';
-import fs, { createReadStream } from 'fs';
-import path2 from 'path';
-import * as tmp from 'tmp';
-import archiver from 'archiver';
-import fsExtra from 'fs-extra';
-import walk from 'ignore-walk';
-
-function getPackageVersion() {
-  const pkgJsonPath = path2.join(__dirname, "..", "..", "..", "package.json");
-  const content = fsExtra.readJSONSync(pkgJsonPath);
-  if (!content.version) {
-    throw new Error("package.json does not contain a version");
-  }
-  return content.version;
-}
-async function zipDirectory(inputDir, outputZip) {
-  const entries = await walk({
-    path: inputDir,
-    ignoreFiles: [".gitignore", ".dockerignore"],
-    includeEmpty: true,
-    follow: false
-  });
-  const output = fs.createWriteStream(outputZip);
-  const archive = archiver("zip", { zlib: { level: 9 } });
-  const finalizePromise = new Promise((resolve, reject) => {
-    output.on("close", resolve);
-    archive.on("error", reject);
-  });
-  archive.pipe(output);
-  for (const entry of entries) {
-    const fullPath = path2.join(inputDir, entry);
-    const stat = fs.statSync(fullPath);
-    const archivePath = entry.split(path2.sep).join("/");
-    if (stat.isFile()) {
-      archive.file(fullPath, { name: archivePath });
-    } else if (stat.isDirectory()) {
-      archive.append("", { name: archivePath.endsWith("/") ? archivePath : archivePath + "/" });
-    }
-  }
-  await archive.finalize();
-  await finalizePromise;
-}
-
-// index.ts
-var program = new Command();
-if (process.argv.length === 3 && ["-v", "--version"].includes(process.argv[2])) {
-  console.log(getPackageVersion());
-  process.exit(0);
-}
-program.name("kernel").description("CLI for Kernel deployment and invocation");
-program.command("deploy").description("Deploy a Kernel application").argument("<entrypoint>", "Path to entrypoint file (TypeScript or Python)").option("--version <version>", "Specify a version for the app (default: latest)").option("--force", "Allow overwrite of an existing version with the same name").action(async (entrypoint, options) => {
-  let { version: versionArg, force } = options;
-  if (!versionArg) {
-    versionArg = "latest";
-    if (force && force !== "true") {
-      console.error("Error: --force must be used when version is latest");
-      process.exit(1);
-    } else if (!force) {
-      force = "true";
-    }
-  }
-  const resolvedEntrypoint = path2.resolve(entrypoint);
-  if (!fs.existsSync(resolvedEntrypoint)) {
-    console.error(`Error: Entrypoint ${resolvedEntrypoint} doesn't exist`);
-    process.exit(1);
-  }
-  const sourceDir = path2.dirname(resolvedEntrypoint);
-  if (!process.env["KERNEL_API_KEY"]) {
-    console.error("Error: KERNEL_API_KEY environment variable is not set");
-    console.error("Please set your Kernel API key using: export KERNEL_API_KEY=your_api_key");
-    process.exit(1);
-  }
-  const client = new Kernel();
-  console.log(chalk.green(`Compressing files...`));
-  const tmpZipFile = tmp.fileSync({ postfix: ".zip" });
-  try {
-    await zipDirectory(path2.join(sourceDir), tmpZipFile.name);
-    console.log(chalk.green(`Deploying app (version: ${versionArg})...`));
-    const response = await client.apps.deploy(
-      {
-        file: createReadStream(tmpZipFile.name),
-        version: versionArg,
-        force,
-        entrypointRelPath: path2.relative(sourceDir, resolvedEntrypoint)
-      },
-      { maxRetries: 0 }
-    );
-    if (!response.success) {
-      console.error("Error deploying to Kernel:", response.message);
-      process.exit(1);
-    }
-    for (const app of response.apps) {
-      console.log(
-        chalk.green(
-          `App "${app.name}" successfully deployed to Kernel with action${app.actions.length > 1 ? "s" : ""}: ${app.actions.map((a) => a.name).join(", ")}`
-        )
-      );
-      console.log(
-        `You can invoke it with: kernel invoke${versionArg !== "latest" ? ` --version ${versionArg}` : ""} ${quoteIfNeeded(app.name)} ${quoteIfNeeded(app.actions[0].name)} '{ ... JSON payload ... }'`
-      );
-    }
-  } catch (error) {
-    console.error("Error deploying to Kernel:", error);
-    process.exit(1);
-  } finally {
-    tmpZipFile.removeCallback();
-  }
-});
-function quoteIfNeeded(str) {
-  if (str.includes(" ")) {
-    return `"${str}"`;
-  }
-  return str;
-}
-program.command("invoke").description("Invoke a deployed Kernel application").option("--version <version>", "Specify a version of the app to invoke").argument("<app_name>", "Name of the application to invoke").argument("<action_name>", "Name of the action to invoke").argument("<payload>", "JSON payload to send to the application").action(async (appName, actionName, payload, options) => {
-  let parsedPayload;
-  try {
-    parsedPayload = JSON.parse(payload);
-  } catch (error) {
-    console.error("Error: Invalid JSON payload");
-    process.exit(1);
-  }
-  if (!process.env["KERNEL_API_KEY"]) {
-    console.error("Error: KERNEL_API_KEY environment variable is not set");
-    console.error("Please set your Kernel API key using: export KERNEL_API_KEY=your_api_key");
-    process.exit(1);
-  }
-  const client = new Kernel();
-  console.log(`Invoking "${appName}" with action "${actionName}" and payload:`);
-  console.log(JSON.stringify(parsedPayload, null, 2));
-  try {
-    const response = await client.apps.invoke({
-      appName,
-      actionName,
-      payload,
-      ...options.version && { version: options.version }
-    });
-    console.log("Result:");
-    console.log(JSON.stringify(JSON.parse(response.output || "{}"), null, 2));
-  } catch (error) {
-    console.error("Error invoking application:", error);
-    process.exit(1);
-  }
-  return;
-});
-program.parse();