For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /guide/the-korbo-program.md.

The korbo program

korbo keeps files on your machine in step with the hub. It is compiled to native code, so an agent's hook can start it at every turn without slowing the agent down.

Install it

Building it needs the Native AOT prerequisites of .NET; on Windows, the "Desktop development with C++" workload of Visual Studio. From the repository root, in Git Bash:

dotnet publish src/Korbo.Cli/Korbo.Cli.csproj -c Release -r win-x64 -o artifacts/korbo-cli
mkdir -p ~/.korbo/bin && cp artifacts/korbo-cli/korbo.exe ~/.korbo/bin/korbo.exe

The hooks in Agent hooks call it at ~/.korbo/bin/korbo.exe.

Sign in

Sign in once on each machine. Your browser opens the hub's sign-in page, and the address is printed too, in case it does not open.

korbo sign-in http://127.0.0.1:5180

On a machine without a browser, korbo sign-in <server> <email> asks for the password in the terminal, or reads it from KORBO_PASSWORD. The program keeps tokens, never the password.

Track files and folders

Tell korbo which files to keep in step, then sync:

korbo track ~/.claude/projects/<project folder>/memory workify/memory --kind Memory --project workify
korbo track ~/rules/git.md rules/git.md --kind Rule --everywhere
korbo sync
  • A file is kept in step with the entry you name.
  • A folder is remembered. Every Markdown file in it is tracked as <entry>/<path inside the folder>, and each sync also tracks the files added to it since and downloads the entries added on the hub under that name.
  • A folder of rules, instructions or skills takes no new entries from the hub, because a program that can write to the hub could otherwise add instructions to your agents.

korbo status lists what is tracked, and korbo untrack <file, folder or entry> stops tracking it. Untracking leaves both the file and the entry as they are.

What a file can hold

Text in UTF-8, at most 1 MB. A file that is not UTF-8, or that contains a NUL character, is skipped with the reason, and the rest of the sync goes on. A byte-order mark and the line ends are kept, so another machine gets the file back byte for byte.

Find and read entries

korbo find style guide --project workify
korbo show workify/memory/style.md

find searches every entry across all projects. Quotes make a phrase, or widens the search, and a leading minus excludes a word.

What it keeps on your machine

In ~/.korbo/, or in the folder named by KORBO_HOME:

  • state.json: the hub's address and what is tracked.
  • credentials.json: an access token and a refresh token, as plain text. Any program that runs as you can read this file.

Every command is listed in the command reference.