Sign in
Developer tools
0%

Developer tools

iohr and iohr-preview

iohr is the released command line. iohr-preview is the next build of the same program, installed beside it, so you can try what is not released yet.

There are two names for one program. iohr is the release: what APT, Homebrew and the installers give you, and what the rest of this site describes. iohr-preview is the next build of the same program under another name. It carries changes that are finished and checked but not yet in a release, so you can try them first.

iohr --version            # the release
iohr-preview --version    # the next build; the number can be the same

How they differ

  • Same commands. Everything in iohr is in iohr-preview. Nothing is removed in the preview.
  • Same program, own name. A hook or a project made by iohr-preview calls itself by that name: iohr-preview shell hook zsh makes a prompt that asks iohr-preview, and a new project's AGENTS.md names the command that made it.
  • Not published as a package. It is not in APT, Homebrew or the installers. You build it yourself from a checkout of the SDK repository.
  • Can change between builds. A preview build is not a promise. When a change is released, it is in iohr and stops being a difference.

Install it

On a Mac, in a checkout of the SDK repository:

cd sdk
git pull
mise run cli:preview-install

It builds iohr from the checkout and installs it as ~/.local/bin/iohr-preview (IOHR_PREVIEW_DIR puts it elsewhere). The copy is signed the way the release is, with an Apple Development or Developer ID certificate from your keychain, so the macOS Keychain trusts every rebuild and stops asking again after each one. A failed signing leaves the installed one as it was. Run it again to update.

The install task is for macOS only.

What the preview has today

These are on the main branch and not in the release (0.1.0-alpha.39):

ChangeWhere it is described
iohr ui serves the InOrbit web UI on this machine and opens it in your browseriohr ui
In iohr panel, a framed chat box at the bottom of the terminal for ? and ??, with progress and Stopiohr panel
iohr project init asks where to keep the project's notes and crawl: the project folder or your home folderProjects
iohr project init asks whether the project is a monolith, microservices or combinedProjects

The chat box is zsh only. Option+h (⌥h, or Alt+h on Linux) hides it and brings it back, and [panel] chat = "hidden" or "off" (or IOHR_PANEL_CHAT) sets how it starts. The two init questions, and the flags that answer them without asking, are in Where the project keeps its data and The project's shape.

What this list held before (the ? card's menu, modes, folders Io may read, iohr session and iohr stop, iohr ask --role, Touch ID for iohr asks approve, extensions offered at init) is in the release now.

This list is the difference as of the build the pages were written against; iohr-preview --help prints what a build has. A page on this site that depends on the preview says so where it matters.

Which one should I use

Use iohr. Use iohr-preview when you want the next build and accept that its output can still move, or when you are checking a change before it is released.