kortix-cli

Controls the Kortix platform from the terminal via the pre-authenticated kortix CLI.

20.2k|3.4k|Updated Oct 5, 2024
One-click install
npx skills add https://github.com/kortix-ai/suna --skill kortix-cli
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kortix-cli
Source: https://github.com/kortix-ai/suna/tree/main/packages/starter/templates/base/.kortix/opencode/skills/kortix-cli
Command: npx skills add https://github.com/kortix-ai/suna --skill kortix-cli

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Agents working inside a Kortix session sandbox often need to act on the project's control plane — managing secrets, spawning subagent sessions, opening change requests, calling connectors — rather than just editing files, and doing that by hand through a dashboard breaks automation.

Core Features & Use Cases

  • Session orchestration: Spawn, watch, and collect results from subagent sessions with commands like kortix sessions new --json --wait and kortix sessions cp for moving deliverables between sandboxes.
  • Change request workflow: Land work on main only through kortix cr open, keeping human review in the loop for every branch merge.
  • Secrets and connectors: Request secrets via human-entry links with kortix secrets request and invoke configured connector actions server-side with kortix connectors call.
  • Use Case: An agent finishes a data analysis on its branch, commits and pushes, opens a change request with kortix cr open --title, then spawns a follow-up session with kortix sessions new --with-file data.csv to build a report from the results.

Quick Start

Ask the agent to run kortix skills get kortix-system to load the full live CLI reference, then use kortix sessions status to see every agent working on the project.

Frequently Asked Questions about kortix-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I spawn a subagent session with the kortix CLI?

Run kortix sessions new --json --wait --prompt "..." to create a session and get a ready session id. Attach input files with --with-file, which places them in /workspace/incoming/ before the prompt runs.

How do I land agent work on the main branch in Kortix?

Commit and push your branch, then run kortix cr open --title "..." to open a change request. A human reviews and merges it; agents never merge their own CRs, and the CR is the only sanctioned path to main.

Is the kortix CLI already authenticated in a session sandbox?

Yes. The binary is on $PATH at /usr/local/bin/kortix, and a project-scoped KORTIX_CLI_TOKEN plus KORTIX_API_URL are pre-injected, so commands work with no setup. Use kortix whoami to confirm the project and account.

Why does a finished Kortix session show as stopped?

A finished session's sandbox stops automatically to save compute; stopped means parked, not failed. Commands like sessions cp, sessions chat, and sessions wait-for wake it on demand.

How do I handle API keys and secrets with the kortix CLI?

Run kortix secrets request <NAME> to mint a link where a human enters the key directly. Agents never handle raw secret values themselves.