Skip to main content
Version: 2.5.0

first run

git repository requirement

kas must be run from within a git repository. on startup, the main entry point checks for a git root and exits with an error if none is found:

kas must be run from within a git repository

this applies both to the interactive tui (kas) and most subcommands. the project-local config directory is anchored to the repository root, but task state is still coordinated through the global shared task store.

project config directory

kasmos separates repo-local runtime directories from the global task store.

repo-local — created automatically under <repo-root> on first run or after kas setup:

pathpurpose
.kasmos/config.tomlagent and phase configuration
.kasmos/signals/compatibility signal sentinel directory
.kasmos/cache/runtime cache
.worktrees/git worktrees created for each agent instance

global task store — shared across all projects on this machine:

pathpurpose
~/.config/kasmos/taskstore.dbsqlite task store (plans, signals, task state)

the resolved db path can be overridden via database_url in .kasmos/config.toml to point at a remote store. use kas debug to print the resolved config and db paths for the current repository.

launching the tui

from inside your git repository, run:

kas

on first launch you will see the general help overlay. press any key to dismiss it.

tui layout

the interface is divided into three main areas:

  • sidebar — topics and plan groups, toggled with ctrl+s
  • instance list — active agent sessions for the selected plan
  • preview pane — live agent output; tabs switch between the agent view, info, diff, and git history

keybindings reference

sessions

keyaction
/ oattach to tmux session fullscreen
sspawn agent
iinteractive mode (type in pane)
ctrl+spaceexit fullscreen or interactive mode
ctrl+entersubmit + exit interactive mode
kkill tmux session (keeps instance)
Kstop session (branch preserved)
rresume paused session
ccheckout branch (pause + copy branch name)
Pcreate pull request
Tbrowse orphaned tmux sessions
1 / 2filter: all / active only
3cycle sort mode

plans

keyaction
nnew plan
spacetoggle plan, topic, or history
/ oselect (context menu or run stage)
v / ppreview selected plan
bopen plan browser
keyaction
tfocus instance list
tab / shift+tabcycle tabs (info ↔ agent)
!interactive + shell mode
# / ginfo tab
/ navigate within focused pane
/ move between panes
ctrl+stoggle sidebar visibility
Ltoggle audit log pane
/search plans and instances
?show help overlay
qquit

execution modes

when you spawn an agent (s), kasmos creates an isolated git worktree and starts the agent in one of two execution modes:

  • tmux — session is attachable (/o); use interactive mode (i) to type directly into the agent pane. best for exploratory work.
  • headless — session runs in the background; output is streamed to the preview pane and logs. best for automated wave work.

the execution mode is set per agent role in config.toml via the execution_mode field. see setup wizard for configuration details.

first task

once the tui is running:

  1. press n to create a new plan
  2. enter a name and description
  3. press to open the plan context menu
  4. select an action to start the planning or implementing phase

if you haven't run kas setup yet, do that first — see setup wizard.