Skip to content
In development Kaleidoscope is not publicly released. Nothing here installs from a registry yet — see what is available.

Connect an editor or agent

connect writes the entry your editor or agent needs to start Kaleidoscope, and disconnect takes it back out. Both touch only the block Kaleidoscope owns.

Terminal window
kaleidoscope connect HOST --profile default --project "$PWD" --dry-run
kaleidoscope connect HOST --profile default --project "$PWD"

HOST is one of codex, claude, cursor, or opencode. Each has its own page under Editors, agents and frameworks, because each writes a different file.

What gets written names an absolute path to the local engine and mcp --profile NAME, and publishes exactly two tools, search and remember. It does not carry your vault location, a provider key, or an account credential.

flagwhat it does
--dry-runprints the exact change and writes nothing
--yesconfirms in advance, for a script
--profile NAMEwhich profile the host will open; default if omitted
--project PATHwhich project directory the change belongs to
--scope user|projectmachine-wide or this project only; project is the default
--opencode-version stable-v1|beta-v2OpenCode only, and never guessed

--scope user writes the entry once for your whole machine. --scope project writes it into the project you named, which is what you usually want when different projects should use different memory.

Terminal window
kaleidoscope disconnect HOST --project "$PWD" --dry-run
kaleidoscope disconnect HOST --project "$PWD"

Disconnect is the exact inverse of connect. It removes only what Kaleidoscope wrote, leaves the rest of the host’s settings alone, and does not touch a single byte of your vault. Pass the same --scope you connected with; a project-scope entry and a user-scope entry are two different entries in two different files.

An unknown host, a conflicting entry name, a malformed file, a symlink, a file being edited at the same time, or ownership markers that have been hand-edited all produce a refusal rather than a rewrite. The file comes back untouched and you are told which of those it was. That is deliberate: a configuration file you maintain is yours, and a tool that guesses at an ambiguous one eventually guesses wrong.

Connecting a host does not tell your agent to use the memory it can now reach. That is a separate step.