Skip to content
Early access Kaleidoscope needs a key to run. Email contact@kleosresearch.xyz and we will send you one.

CLI reference

kscope is the command. It creates a vault, wires your editor to it, and answers questions about both.

Terminal window
npm install -g @kleos-research/kaleidoscope
kscope --help

The full help text is the authority on every argument.

To do thisRunPage
Create a vault and wire your editorinitConnect an editor
Write the instruction file and skillinitAgent instructions
Name a vault so an editor can start with itinit-profile, profile create, profile importProfiles and vaults
See, inspect or forget a profileprofile list, profile show, profile launch, profile removeProfiles and vaults
Find out which vault you are talking towhereDiagnostics
Check the key, the model, the vaultgate, activate, model, vault-verifyDiagnostics
Run an engine for an agentmcp, callMCP reference
Migrate, preview or delete a vaultvault-migrate, vault-preview, vault-deleteOperations
Upgrade a vault, or undo the upgradevault-upgrade, vault-rollbackOperations
Read the tool contractschemaMCP reference
Read the third-party noticeslicences—

kscope init appears twice because one run does both jobs: it creates the vault, then tells every agent on this machine that the vault exists.

FlagOnEffect
--profile NAMEmcp, callWork in the vault that profile names. Nothing else accepts it.
--no-wireinitCreate the vault and write no editor configuration.
--sharedinitWire this project’s agents to the shared vault in your home folder instead of giving the project its own.
--vault PROFILEinitWire this project’s agents to the vault an existing profile names, and create none.
--confirm HEADvault-rollbackUndo the upgrade. Take the exact command the dry run prints.
--root-onlywherePrint only the vault root and the project it came from.
--cross-backendvault-verifyWiden the check.
--help, -hany invocationPrint the command surface.
--version, -Vany invocationPrint the version.

kscope init takes no --profile. It works on the directory you are in, or on a root you name as a positional argument.

There is no --engine, no --dry-run and no --yes. An unknown verb prints the help text; an unknown argument to init is refused by name, and nothing is created.

WhatWhereWhy
MCP server entrythe project, or for Claude Code, that project’s entry in ~/.claude.jsonEach project’s agents open that project’s own vault. init writes the entry in every existing checkout of the repository, and kscope where says when a newer worktree needs one.
Instruction file and skillthe projectGit carries them into a worktree or clone.

What init writes, and what it leaves alone

Section titled “What init writes, and what it leaves alone”
  • Kaleidoscope writes only the block it owns, between ownership comments wherever the file format has room for them.
  • Every file it writes gets a receipt beside it: config.toml.kaleidoscope-owner.json beside a host configuration, CLAUDE.md.kaleidoscope-instruction-owner.json beside an instruction file. Claude Code’s receipt for a project’s entry sits beside ~/.claude.json, one per project.
  • A file it changes rather than creates is copied to <name>.kaleidoscope-backup first. The rest of the file is untouched.
  • If what it finds no longer matches the receipt, it stops at that file and reports that step as failed. The other steps still run.
  • The configuration it writes carries no token, no provider key and no vault location. It names this executable, a profile, and the tools search and remember.
  • Running kscope init again is safe. An existing vault is left as it is and the wiring is re-checked.

Some verbs written about elsewhere — connect, disconnect, config, doctor, teardown, profile use, instructions install, and the whole account surface — belong to kaleidoscope, a second executable built from source and published on no channel. Nothing on this site asks you to run one. Account commands lists them.