MachineMachine
MachineMachine
MachineGetting startedQuickstartAccounts & access
Your project
AgentsLegacy kortix.tomlManifest referenceModelsAgent permissionsSecrets
Running work
Change requestsRuntime & sandboxSessions
Connect & automate
ComputersConnectorsInkbox: iMessage, SMS, email & callsMCP serverPixio: images, video & audioRemindersSlack & channelsMicrosoft TeamsTriggers
Feature flags
Apps

Develop

CLI
TypeScript SDKFull exampleAuthenticationSign in with KortixSessionsAppsReact hooksSDK reference
Machine as a BackendAPI reference
GitHub

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.

Run the install script. It downloads the kortix binary for your OS.

bash
curl -fsSL https://kortix.com/install | bash

Kortix supports macOS and Linux. There is no Windows binary yet.

bash
kortix login

This opens your browser for sign-in. After you sign in, kortix login picks your account and a default project for you.

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.

bash
kortix init my-app
cd my-app
kortix ship

kortix 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:

bash
kortix projects clone <project-id>

Find <project-id> with kortix projects ls.

bash
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:

bash
kortix sessions chat

When the agent finishes, it opens a change request with a summary and the exact diff.

bash
kortix cr ls

This lists the open CRs in your project. Review the one the agent opened, then merge it to land the work on your default branch:

bash
kortix cr merge 1

Replace 1 with the CR number from kortix cr ls. Nothing reaches your project's default branch until you merge.

Next steps

How the pieces fit

Projects, sessions, and change requests, explained.

CLI command reference

Every command, flag, and subcommand.

The CLI dev loop

Link a repo, ship code, and manage sessions from your terminal.

PreviousGetting startedNextAccounts & access

On this page

Next steps