Skip to content

Getting Started Install

Jump to bottom
github-actions[bot] edited this page Oct 16, 2026 · 1 revision

Install Kanna globally with Bun.

Kanna ships as a global Bun CLI: @cuongtran001/kanna.

Requirements

  • macOS or Linux (Windows not supported)
  • Bun 1.3.11 or newer — install with curl -fsSL https://bun.sh/install | bash
  • Credentials for at least one provider:
    • Claude — a Claude OAuth token, added in Settings → Providers
    • Codex — a working codex CLI login
    • OpenRouter — an OpenRouter API key

Install

bun install -g @cuongtran001/kanna

Run

From any project directory:

kanna

Kanna opens in your browser at localhost:3210.

Everything is configured with flags — kanna --help lists them. The common ones are --port, --password and --remote; see Self-host basics if you are exposing the instance.

Your data lives in ~/.kanna.

Update

bun install -g @cuongtran001/kanna@latest

Or use the in-app Update button — see Self-update.

Uninstall

bun pm uninstall -g @cuongtran001/kanna

This wiki is generated from wiki/src/content/docs in cuongtranba/kanna.

Edit the docs there: changes made on this wiki are overwritten on the next sync.

The same docs are published at https://kanna-wiki.lowbit.link.

Home · Docs site ↗

Getting Started

Features

Guides

Sharing

Reference

Changelog

Clone this wiki locally