kernel-cli

Kernel CLI

Kernel CLI 提供对 Kernel 云浏览器平台的命令行访问能力，可用于浏览器自动化、无服务器应用部署和基础设施管理。

安装

• Homebrew：brew install kernel/tap/kernel
• npm：npm install -g @onkernel/cli

运行 kernel --version 进行验证。请以 kernel <command> --help 的输出为准，了解已安装版本的相关信息。

身份验证

• 首选： 设置 KERNEL_API_KEY 环境变量
• 备用： 运行 kernel login 进行交互式 OAuth 身份验证

快速入门

# Authenticate
export KERNEL_API_KEY=your_api_key

# Create a browser session
kernel browsers create -o json

# Run Playwright automation (use `return` to get a value back)
kernel browsers playwright execute <session_id> '
  await page.goto("https://example.com");
  return await page.evaluate(() => document.title);
'

# Take a screenshot
kernel browsers computer screenshot <session_id> --to screenshot.png

# Cleanup
kernel browsers delete <session_id>

安全操作

• 在脚本中优先使用 -o json 和 jq；deploy 和 invoke 会输出 JSONL，而不是单个 JSON 对象。
• 如果 API 密钥可访问多个项目，请使用 --project <id-or-name> 或 KERNEL_PROJECT。
• 除非有意进行非交互式执行，否则请保留破坏性操作的确认提示。
• 测试后删除创建的浏览器会话和池。切勿回显、记录、提交或分享 API 密钥、凭据或代理密码。

项目、API 密钥和组织管理

# Rename, archive, or reactivate a project (provide at least one update)
kernel projects update <id-or-name> --name <new-name> -o json
kernel projects update <id-or-name> --status archived -o json
kernel projects update <id-or-name> --status active -o json

# Look up a soft-deleted API key
kernel api-keys get <id> --include-deleted -o json

# Inspect limits before changing the default project cap
kernel org limits get -o json
kernel org limits set --default-project-max-concurrent-sessions <n> -o json

对于 org limits set，0 会移除默认上限；设定值不能超过组织的并发限制。

使用 kernel api-keys rotate <id> 以交互方式轮换 API 密钥。使用 --days-to-expire <1-3650> 设置替换密钥的有效期，使用 --expire-in-days <n> 设置旧密钥的宽限期（默认为 7 天；0 表示立即撤销）。输出中会包含一次性的替换明文密钥：请勿将其记录到日志中，在宽限期内迁移调用方，然后验证旧密钥已失效。

参考资料

• 浏览器管理 - 创建、列出、查看和删除浏览器会话
• 应用部署 - 部署 TypeScript/Python 应用并调用操作
• 计算机控制 - 操作系统级别的鼠标、键盘和屏幕截图功能
• 进程执行 - 在浏览器 VM 中执行和管理进程
• 配置文件 - 管理持久化浏览器配置文件
• 托管身份验证 - 身份验证连接、登录会话、凭据提供方和自动重新身份验证
• 代理 - 创建和管理数据中心、ISP、住宅和移动代理
• 浏览器池 - 管理预热浏览器池
• 扩展程序 - 上传和管理 Chrome 扩展程序
• 回放 - 录制和下载视频回放
• 文件系统操作 - 读取、写入、上传和下载文件