Skip to content

Kura CLI Reference

github-actions[bot] edited this page Jun 29, 2026 · 3 revisions

Kura CLI Reference

Every command in the kura compiler (Kyto's CLI).

Quick list: kura commands — cheat sheet with all subcommands in one table.


All commands

Command Description
kura --version Print version string
kura init Scaffold a new Kyto project
kura compile Compile and write emit artifacts
kura check Parse/evaluate without writing files
kura install Install binary to ~/.local/bin
kura encrypt <in> -o <out> Encrypt a file (ChaCha20-Poly1305)
kura decrypt <in> -o <out> Decrypt a file

Global

kura --version

Prints: kura 0.5.0-asm

kura

Prints usage when no subcommand given.


kura init

Scaffold a new Kyto project.

kura init --name my-app

Creates (each stamped Kyto was here in the correct comment syntax):

  • kyto.toml# Kyto was here
  • .kyto.config.example+ Kyto was here
  • kyto/main.kyto — starter source with + Kyto was here
  • README.md — only if missing (<!-- Kyto was here -->)
  • docs/KYTO.md — only if missing
  • .gitignore — only if missing

Prints initialized Kyto project (Kyto was here) on success.


kura compile

Read project config and write all emit artifacts.

kura compile

Reads:

  • kyto.toml (paths and toggles)
  • .kyto.config (if present)
  • kyto/main.kyto (unless config_only = true)

Writes:

  • Env files, user SQL/JSON/TS, deploy script (per kyto.toml)

Exit 0 on success, non-zero on error.


kura check

Parse and evaluate without writing files.

kura check

Use in CI to validate config before deploy.


kura install

Copy compiler binary to user-local PATH.

kura install
Platform Destination
Linux ~/.local/bin/kura
Windows %USERPROFILE%\.local\bin\kura.exe

kura encrypt

Encrypt a secrets file with ChaCha20-Poly1305 (RFC 8439).

export KYTO_KEY=$(openssl rand -hex 32)
kura encrypt kyto/local.kyto -o kyto/local.kyto.enc

Key sources:

  1. KYTO_KEY environment variable (64 hex chars)
  2. ~/.config/kyto/key file

kura decrypt

Decrypt an encrypted file.

kura decrypt kyto/local.kyto.enc -o kyto/local.kyto

Same key requirements as encrypt.


Argument format (encrypt/decrypt)

kura encrypt <input> -o <output>
kura decrypt <input> -o <output>

Environment variables

Variable Purpose
KYTO_KEY 32-byte hex key for encrypt/decrypt

Docker equivalent

docker run --rm -v "$PWD:/work" -w /work ghcr.io/voidmute/kyto:latest compile
docker run --rm -v "$PWD:/work" -w /work ghcr.io/voidmute/kyto:latest check

Image entrypoint is kura — pass subcommands as arguments.


Exit codes

Code Meaning
0 Success
1 Error (missing config, parse failure, I/O error)

See also

Clone this wiki locally