Documentation

The documentation lives in the repository, so it is versioned with the code it describes and can never quietly drift out of date. These links go straight to it.

Install and run

All five SDKs implement the same execution API and pass the same conformance corpus.

shell

# Python is on PyPI.
pip install kryon

# Also live:
npm install kryon-exec
dart pub add kryon
# Gradle: io.github.piyush-mishra-00:kryon:1.0.0
# Gradle: io.github.piyush-mishra-00:kryon-kotlin:1.0.0

Overview

What Kryon is, what it is not, and the three design decisions that shape the API.

Installation

Per ecosystem, with the honest status of each.

Your first commands

From one command to a live streaming process, in eight steps.

Python SDK reference

Every option, result field, process method and error, with platform notes.

TypeScript SDK reference

ESM, AbortSignal cancellation, and a browser build with no runtime.

Dart SDK reference

Stream-based output with real backpressure, zero dependencies.

Java SDK reference

Builders, try-with-resources, and the two JVM limitations stated plainly.

Kotlin SDK reference

Coroutines, Flow, and cancellation that actually reaches the child.

Understand it

Architecture

The five layers, why each boundary is where it is, and what is deliberately absent.

SDK design

How five SDKs stay one product — and why there is no shared native core.

Why Kryon?

Honest comparison with subprocess APIs, PTY libraries and terminal components — including when to use those instead.

Platform support

The compatibility matrix, and the Windows differences that will bite you.

Read before shipping

Kryon executes arbitrary commands. These four documents are the ones that matter most.

Threat model

What Kryon defends against, what it explicitly does not, and the attacker scenarios in a table.

Command execution

Argument vectors versus shell strings, and what the vector still does not protect.

Remote execution

The only correct shape for a browser-facing terminal, and the one that is a breach.

Sandboxing

What actually isolates a process. None of it is Kryon.

Specification

Normative and language-neutral. Where the specification and the documentation disagree, the specification wins and the documentation has a bug.

Execution

Options, results, termination reasons, timeouts, output limits, the failure model.

Process

Streaming, backpressure, input, signals, lifecycle, resource ownership.

Errors

The taxonomy, and the rule for which failures are errors at all.

Terminal Design

PTY sessions and the emulator model. Not implemented.

Transport Design

The transport interface and the security requirements for a server. Not implemented.

Conformance

The helper contract and corpus format that make one test suite run from five languages.

Contribute

Contributing

Setup, branching, commits, and what gets a pull request declined.

Testing

Unit, conformance and platform tests — and what must always be tested.

Add an SDK

The highest-value contribution available. Six steps, in order.

Releases

Versioning, tags, registries and the rules about credentials.