> ## Documentation Index
> Fetch the complete documentation index at: https://tbd-6fc993ce-hypeship-docs-website-deploy-hook.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Kernel CLI

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

## Installation

```bash theme={null}
# Using brew
brew install kernel/tap/kernel

# Using pnpm
pnpm install -g @onkernel/cli

# Using npm
npm install -g @onkernel/cli
```

Verify installation:

```bash theme={null}
which kernel
kernel --version
```

<Columns cols={2}>
  <Card icon="code" title="Create Kernel App" href="/reference/cli/create">
    Scaffold new Kernel apps from templates.
  </Card>

  <Card icon="key" title="Authentication" href="/reference/cli/auth">
    Login, logout, and check auth status.
  </Card>

  <Card icon="browsers" title="Browsers" href="/reference/cli/browsers">
    Create, view, and manage Kernel browsers.
  </Card>

  <Card icon="layer-group" title="Browser Pools" href="/reference/cli/browser-pools">
    Pre-warm and reuse pools of browsers.
  </Card>

  <Card icon="fingerprint" title="Profiles" href="/reference/cli/profiles">
    Persist and reuse browser profiles.
  </Card>

  <Card icon="globe" title="Proxies" href="/reference/cli/proxies">
    Create and manage proxy configurations.
  </Card>

  <Card icon="rocket" title="Apps" href="/reference/cli/apps">
    Deploy apps, invoke actions, and stream logs.
  </Card>

  <Card icon="lock" title="Managed Auth" href="/reference/cli/managed-auth">
    Manage auth connections, credentials, and credential providers.
  </Card>

  <Card icon="puzzle-piece" title="Extensions" href="/reference/cli/extensions">
    Upload, download, and build browser extensions.
  </Card>

  <Card icon="code-fork" title="MCP" href="/reference/cli/mcp">
    Install Kernel MCP server configuration for AI tools.
  </Card>

  <Card icon="folder-tree" title="Projects" href="/reference/cli/projects">
    Manage projects and scope commands with `--project`.
  </Card>

  <Card icon="key" title="API Keys" href="/reference/cli/api-keys">
    Create, list, rename, and delete API keys.
  </Card>
</Columns>

## Quick Start

```bash theme={null}
# 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-or-name>` - Scope the request to a specific [project](/reference/cli/projects) (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:

```bash theme={null}
# 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`).

```bash theme={null}
# Load completions for the current zsh session
source <(kernel completion zsh)
```

<Info>
  Looking for the API? See the [API Reference](https://kernel.sh/docs/api-reference/invocations/invoke-an-action).
</Info>

## Skills

The Kernel CLI has a companion [skills file](https://github.com/kernel/skills/blob/main/plugins/kernel-cli/skills/kernel-cli/SKILL.md) 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.