A textual-based terminal user interface application
Project description
Kiwi Code
Kiwi Code is a terminal-first UI (TUI) for chatting with Kiwi Actions and managing runs (action results). It also integrates with the Kiwi Runtime (a local CLI/terminal agent) so actions can execute terminal commands on your machine.
- TUI:
kiwi(orpython -m kiwi_tui.main) - CLI:
kiwicli(optional; scripting / inspection)
Requires Python 3.13+.
Quick start
1) Install
pip install kiwi-code
2) Start the TUI
Connect using a server preset:
kiwi connect --server app
Available presets:
- app (prod)
- dev (dev)
3) Login
The TUI will prompt for login if you’re not authenticated.
Tokens/config are stored under:
- ~/.kiwi/tokens.json
- ~/.kiwi/config.json
4) (Optional) Start the Runtime
If you want to run the runtime manually:
kiwi-runtime connect --server dev --scope full
Or for production:
kiwi-runtime connect --server app --scope full
Notes
- --scope full gives unrestricted access. Use restricted if you want tighter control.
- In most cases, you can skip manual runtime startup and just use /connect-cli inside the TUI.
2) Start the TUI
Choose a server preset:
app(prod)dev(dev)local(localhost)
uv run python -m kiwi_tui.main --server dev
Or, if installed as a package:
kiwi --server dev
3) Login
The TUI will show a login screen if you’re not authenticated.
Tokens/config are stored under:
~/.kiwi/tokens.json~/.kiwi/config.json
Daily workflow (TUI)
Pick an action → chat
/actions list→ pick an action- Type a message and press Enter
Start a fresh conversation
/newresets the chat to the default action and clears history in the UI.
Continue an existing run (conversation)
/runs list→ pick a run- or
/continue <run_id>
Kiwi Code will load the conversation history for that run.
Local CLI agent (Runtime)
Some actions can execute terminal commands via a local runtime process.
Connect the runtime to the current run
Inside the TUI:
/connect-cli
What it does:
- Ensures a local runtime exists for the current run_id.
- If the runtime was disconnected (e.g., server redeploy), Kiwi Code detects it and starts a fresh one.
- Sends the instruction prompt: “Connect to the CLI right now before asking or doing anything.”
View runtime logs
- Slash command:
/show-logs - Keyboard shortcut: Ctrl+O (works even while the chat input is disabled / streaming)
Runtime lifecycle
- Runtime processes are tracked under
~/.kiwi/runtimes/. - Runtimes are per run_id (one runtime process per run).
- Runtimes may survive TUI restarts.
- On quit (
Ctrl+C), Kiwi Code shows an exit prompt listing runtimes and lets you choose which to kill.
Keyboard shortcuts (TUI)
These are designed to work even when input is blocked during streaming.
| Key | Action |
|---|---|
Ctrl+C |
Quit (shows runtime cleanup prompt if runtimes are alive) |
Ctrl+O |
Open CLI logs (/show-logs) |
Ctrl+G |
Open slash-command picker (/ ...) |
Ctrl+U |
Attach files / content (@ ...) |
Ctrl+J |
Send message |
Slash commands (TUI)
Session
/use <action_id>— switch action (starts a fresh chat UI)/actions list— list & select actions/new— new conversation (default action)/continue <run_id>— continue an existing run and load history/runs list— list & select runs/status— show current action/run ids
Files
@opens the inline file picker/upload <path> [path2 ...]uploads files and attaches them to your next message/filesshows pending attachments/clear-filesclears pending attachments
Runtime
/connect-cli— ensure runtime exists (per run_id) + send “connect” prompt/show-logs— open runtime logs screen
CLI (optional)
kiwicli provides the same “list/get” style commands for scripting and inspection.
Examples:
kiwicli actions list
kiwicli actions get <action_id>
kiwicli runs list --status processing
kiwicli runs get <run_id>
Server / flags
kiwi / python -m kiwi_tui.main supports runtime flags (mirrors kiwi-runtime connect). These flags are used when Kiwi Code needs to start a runtime.
kiwi --server dev \
--scope restricted \
--allow /some/extra/dir
--server:app | dev | local | <full url>--scope:restricted | full--allow PATH: repeatable; additional allowed directories in restricted mode
Note: Kiwi Code does not modify the runtime implementation under
src/kiwi_runtime/.
Using kiwi-runtime standalone (advanced)
You can run the Kiwi Runtime by itself (without the TUI). This is useful for:
- debugging runtime connectivity / permissions
- keeping a long-lived runtime running in a separate terminal tab
- watching runtime activity/logs directly
Start the runtime
If you installed kiwi-code as a package:
kiwi-runtime connect --server dev --scope restricted --allow "$PWD"
From the repo (recommended for development):
uv run python -m kiwi_runtime.main connect --server dev --scope restricted --allow "$PWD"
Notes:
--serversupports presets:app,dev,local(or a full URL).--scope restrictedis the default; use--allowto add directories.- The runtime prints connection status and will remain running until you stop it.
Authentication
The runtime typically needs an access token. When you run the TUI and log in, your token is saved to:
~/.kiwi/tokens.json
You can pass the token explicitly (if required by your setup):
kiwi-runtime connect --server dev --token <ACCESS_TOKEN>
Stop the runtime
Press Ctrl+C in the runtime terminal to disconnect and exit.
Important behavior when running standalone
- Standalone runtimes are not tracked in
~/.kiwi/runtimes/(that directory is used by kiwi-code to track TUI-managed runtimes). - If you run the TUI and then run
/connect-cli, kiwi-code may start its own runtime process if it doesn’t detect a managed runtime for the current run.- For normal usage, prefer letting the TUI manage the runtime via
/connect-cli. - For standalone/debug usage, run
kiwi-runtime connect ...in a separate terminal and use it to observe activity.
- For normal usage, prefer letting the TUI manage the runtime via
Troubleshooting
“CLI runtime stopped responding” after server redeploy
If the backend restarts (common in dev), the runtime websocket may close.
Fix:
- In Kiwi Code, run
/connect-cliagain. - If needed, open logs (Ctrl+O) to confirm the new runtime connected.
Kiwi Code validates existing runtime processes and will restart them when they’re invalid/disconnected.
Quit shows a runtime cleanup prompt
This is expected. Select runtimes to kill (or press Esc to keep them running).
Development
git clone https://github.com/jetoslabs/kiwi-code.git
cd kiwi-code
uv sync
uv run python -m kiwi_tui.main --server dev
Run tests:
uv run python -m pytest -q
License
Proprietary. All rights reserved.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kiwi_code-0.0.21.tar.gz.
File metadata
- Download URL: kiwi_code-0.0.21.tar.gz
- Upload date:
- Size: 180.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5a3a392dc1935ec1dc99d4cd7c552ed93011e7f1fcb8dacde680e1be38db420f
|
|
| MD5 |
e020c11200fa247a779364cea871ce27
|
|
| BLAKE2b-256 |
00207e6ed39bfb92495c8673da3cdc66a95c6230c2d1b71f614ddb3a399b7285
|
File details
Details for the file kiwi_code-0.0.21-py3-none-any.whl.
File metadata
- Download URL: kiwi_code-0.0.21-py3-none-any.whl
- Upload date:
- Size: 91.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e1b031779facd626d83cd75f2245f5634cf7c7cf6d9fe4efc73653692ea5a5cc
|
|
| MD5 |
49fd8086f431d20d2747ac4ab836c756
|
|
| BLAKE2b-256 |
58e26fd52578c3af566417fd40703626222e6313420e836086b95a4a5eab17f5
|