Skip to content
Kairo
Docs / Introduction

Getting started

Kairo CLI

Write and publish Kairo build logs without leaving your terminal. The website is where people read build logs; the CLI is where you write them.

What the Kairo CLI is#

kairo is a command-line tool that turns a git commit into a build log on Kairo. You run it inside a repository, it reads your latest commit, Kairo’s AI writer drafts a title and a summary, and you read, edit and approve that draft in the terminal. Only when you approve it does it become a build log on your project.

The whole CLI
kairo login       # connect this machine to your Kairo account
kairo whoami      # check which account it is signed in as
kairo review      # draft a build log from your latest commit
kairo publish     # publish an open source contribution build log from your active pull request
kairo install     # offer a build log after every commit in this repository
kairo uninstall   # stop offering
kairo logout      # sign this machine out and delete its credentials
kairo --help      # everything

Why it exists#

The work of building in public is rarely the building — it’s remembering to write about it afterwards. By the time you open a browser, the context of a commit is already fading. The CLI asks at the moment you have the most to say: right after you commit.

  • No context switch. You stay in the terminal you were already working in.
  • A first draft, not a blank page. The AI writer starts from your commit message, branch and the size of the change.
  • You stay the author. Nothing is published until you read the draft and confirm it twice.

How it fits into Build in Public#

On Kairo, each project has a timeline of build logs — short updates on what you shipped. Readers follow them on your project’s page and in the feed. The CLI is simply a faster way to add to that timeline from where the work happens.

From commit to build log

  1. git commit

    You ship something

  2. kairo review

    Run it yourself, or let the hook run it

  3. AI drafts a build log

    Title, summary and suggested tags

  4. You review and edit

    In the terminal

  5. You publish

    After confirming the destination

  6. Visible on Kairo

    On the project page and in the feed

Before you start#

You need three things in place:

  • A Kairo account with a username. Publishing is refused until your profile is set up.
  • A Kairo project you own, with its GitHub repository connected — on the project’s page, click Connect repository.
  • A local clone of that repository whose origin remote points at GitHub.

Ready? Start with Installation.