Skip to content

cli.mdx

Latest commit

 

History

History
123 lines (92 loc) · 3.51 KB

cli.mdx

File metadata and controls

123 lines (92 loc) · 3.51 KB
Raw
title Kernel CLI

The Kernel CLI helps you access and manage your Kernel resources.

Installation

# Using brew
brew install onkernel/tap/kernel

# Using pnpm
pnpm install -g @onkernel/cli

# Using npm
npm install -g @onkernel/cli

Verify installation:

which kernel
kernel --version
Scaffold new Kernel apps from templates. Login, logout, and check auth status. Create, view, and manage Kernel browsers. Deploy apps, invoke actions, and stream logs. Manage auth connections, credentials, and credential providers. Upload, download, and build browser extensions. Install Kernel MCP server configuration for AI tools. Manage projects and scope commands with `--project`. Create, list, rename, and delete API keys.

Quick Start

# 1) Create a new app
kernel create

# 2) Login
kernel login

# 3) Deploy your app
kernel deploy index.ts

# 4) Invoke your app
kernel invoke my-app action-name --payload '{"key":"value"}'

Global Flags

  • --version, -v - Print the CLI version
  • --no-color - Disable color output
  • --log-level <level> - Set the log level (trace, debug, info, warn, error, fatal, print)
  • --project <id> - Scope the request to a specific project by ID. The value is forwarded verbatim as the X-Kernel-Project-Id header, so pass an ID (not a name). Also reads the KERNEL_PROJECT env var.

JSON Output

Many commands support --output json (or -o json) for machine-readable output, useful for scripting and automation:

# Get browser session as JSON
kernel browsers create -o json

# List apps as JSON array
kernel app list -o json

# Deploy with JSONL streaming (one JSON object per line)
kernel deploy index.ts -o json

See individual command documentation for JSON output availability.

Utility Commands

kernel status

Check the operational status of Kernel services.

  • --output json, -o json - Output raw JSON object.

kernel upgrade

Upgrade the Kernel CLI to the latest version.

  • --dry-run - Show what would be executed without running it.

kernel completion <shell>

Generate a shell autocompletion script (bash, zsh, fish, or powershell).

# Load completions for the current zsh session
source <(kernel completion zsh)
Looking for the API? See the [API Reference](https://kernel.sh/docs/api-reference/invocations/invoke-an-action).

Skills

The Kernel CLI has a companion skills file that AI coding agents (Cursor, Claude, Windsurf, etc.) can use to learn the CLI's commands and capabilities. Copy the prompt from the homepage or point your agent directly at the skill file to get started.