Skip to content

Overview

Every clanka command, the argument they share, and the global flags.

Updated View as Markdown
clanka <command> [arguments]

Start with clanka init, edit the soul.md it prints, then talk with the companion through clanka chat or serve it to an MCP host with clanka mcp.

The soul argument

Most commands take the companion’s soul.md as their first argument: the path that clanka init prints, and that clanka list shows again.

clanka memories ~/.config/clanka/souls/<id>.md

Command reference

  • Set up: init creates a companion. soul lints, drafts and prints a soul, and settles a persona change. embedding downloads the embedding model.
  • Talk: chat in the terminal. mcp for an MCP host. hermes for Hermes profiles and Nightshade.
  • Inspect: memories prints what a companion remembers. recall shows what one query brings up. eval measures recall over a cases file. tics finds prose tics in replies.
  • Repair: doctor freezes, logs, rolls back, rewrites and deletes memories.
  • Move: list shows the companions on this machine. export and import move one to another machine.

Help

Every command explains itself, in three equivalent ways:

clanka help doctor rollback
clanka doctor rollback help
clanka doctor rollback --help

Global flags

--help, -h

Print help for the selected command without running it. -h prints a summary.

clanka chat --help

--version, -V

Print the version.

clanka --version
Navigation

Type to search…

↑↓ navigate↵ selectEsc close