Quickstart
Install the CLI, run a session, and merge your first change request.
This page takes you from a fresh terminal to a merged change request (CR). Every command below is copy-pasteable.
Install the CLI
Run the install script. It downloads the kortix binary for your OS.
curl -fsSL https://kortix.com/install | bashKortix supports macOS and Linux. There is no Windows binary yet.
Sign in
kortix loginThis opens your browser for sign-in. After you sign in, kortix login picks
your account and a default project for you.
Create or clone a project
A new account has no projects yet, so kortix login has none to pick. Run
kortix init with a name to create your first project. This scaffolds a
project directory on your machine.
kortix init my-app
cd my-app
kortix shipkortix ship creates the project in Kortix Cloud on its first run, then
pushes your code. Run kortix ship again any time to sync local changes.
To work on a project that already exists in Kortix Cloud, clone it instead:
kortix projects clone <project-id>Find <project-id> with kortix projects ls.
Run a session
kortix sessions new --prompt "Build the login page"This starts a session. The agent works in its own sandbox, on its own branch, so your project is not touched yet.
Attach to the session to watch progress and reply:
kortix sessions chatReview and merge the change request
When the agent finishes, it opens a change request with a summary and the exact diff.
kortix cr lsThis lists the open CRs in your project. Review the one the agent opened, then merge it to land the work on your default branch:
kortix cr merge 1Replace 1 with the CR number from kortix cr ls. Nothing reaches your
project's default branch until you merge.