CLI Reference

tynix COMMAND [OPTIONS]

Global options: -h, --help on any command, and -v, --version at the top level.

Conventions

• Exit status is 0 on success and 1 when any diagnostic is reported or any file fails. Commands never write partial output on failure.
• Diagnostics have the shape line:col: [CODE] message, where line:col is the start of the offending expression (1-based). The few diagnostics without a source position omit the prefix. Codes are listed in diagnostics.
• Output. Results go to standard output. Text-mode errors go to standard error. With --format json, the JSON report (success or failure) goes to standard output.
• Paths given on the command line are relative to the current directory. DIRECTORY arguments default to the current directory.
• Declarations. Every analysis loads the declaration world of the file's workspace; see how declaration files are found.

tynix check

tynix check FILE [-f|--format text|json]

Analyzes FILE and prints the inferred root type and the type of every let-bound name of the root let, sorted by name:

root: String
greeting :: String

A declaration-only file (.d.tynix) prints nothing when it checks. A failing check prints the diagnostic to standard error and exits 1:

3:14: [TC0013] type mismatch: 42 vs String

tynix compile

tynix compile FILE [-o|--output OUTPUT] [--no-check]

Checks FILE, erases all type syntax and prints the resulting Nix, or writes it to OUTPUT (parent directories are created; the write is atomic). Fails without output if the file does not check. --no-check skips type checking and only erases, like TypeScript's transpile-only mode: parse errors still fail, type errors do not. A declaration-only file cannot be compiled.

tynix emit

tynix emit FILE [-o|--output OUTPUT]

Checks FILE and prints a declaration file describing it, or writes it to OUTPUT. The declare target is FILE with a .nix extension, relative to the declaration's location. Fails with TD0008 for a declaration-only file. See declaration emit for how members are chosen.

tynix init

tynix init [DIRECTORY] [--editor EDITOR]...

Creates DIRECTORY if needed and writes a default tynix.config.tynix, then runs scaffold. Fails if tynix.config.tynix already exists. The project name defaults to the directory name. Each --editor (repeatable) also runs tynix ide install EDITOR for the new project.

tynix scaffold

tynix scaffold [DIRECTORY]

Reads DIRECTORY/tynix.config.tynix and creates whichever of these files are missing, never overwriting existing ones:

• tynix.config.d.tynix: types for the config file,
• the entry file (by default src/main.tynix),
• declarationDir/builtins.d.tynix when builtins = true.

builtins is already typed by the prelude built into the binary. A scaffolded builtins.d.tynix replaces that prelude with its short starter list, so delete it (and set builtins = false) unless you want to restrict the builtins.

tynix check-project

tynix check-project [DIRECTORY] [-f|--format text|json]

Loads DIRECTORY/tynix.config.tynix, discovers sources (see source discovery), and checks every one, sharing one declaration cache. All files are checked even if some fail.

checked project hello-tynix
root: /home/you/hello-tynix
- ok src/main.tynix
  root: String
  greeting :: String

Fails with no project source files discovered when discovery finds nothing, and with missing tynix.config.tynix in DIRECTORY without a config.

tynix build

tynix build [DIRECTORY] [-f|--format text|json]

For every discovered source, compiles it to buildDir/<relative>.nix and emits generatedDeclarationDir/<relative>.d.tynix, where <relative> is the source's path relative to sourceDir (or to the project root for sources outside sourceDir). If any source fails, nothing is written.

tynix emit-project

tynix emit-project [DIRECTORY] [-f|--format text|json]

Like build, but writes only the declaration files.

tynix version

tynix version [-f|--format text|json]

Prints tynix <version>. tynix --version prints the same text.

tynix lsp

tynix lsp [--log-file PATH]

Executes tynix-lsp --stdio, which must be on PATH. Editors usually start tynix-lsp directly; this subcommand exists so a single binary name can be configured everywhere. --log-file is forwarded to the server.

tynix ide

tynix ide install vscode|cursor|vscodium|zed|neovim|helix
                 [--project DIR | -g|--global] [-n|--dry-run]
                 [--no-extension] [--force] [--lsp-path PATH]
tynix ide list

tynix ide install EDITOR installs the tynix extension (where the editor has one) and merges the editor configuration that starts tynix-lsp: project settings under the current directory (or --project DIR) by default, user settings with --global. Settings are merged, never clobbered, and re-running the command is a no-op. --dry-run prints the planned commands and a diff without changing anything, --no-extension only writes configuration, --force rewrites files that cannot be merged safely after saving a .bak copy, and --lsp-path pins a tynix-lsp path ("" pins nothing).

tynix ide list prints the supported editors and whether each one is detected.

Editor setup documents what each editor gets.

tynix doctor

tynix doctor [-f|--format text|json]

Checks that tynix and tynix-lsp are on PATH and report the same version, that the current project's tynix.config.tynix loads, that each detected editor has the tynix integration, and that nix is available. Each check prints one line, with a suggested fix for each problem. Exits 1 if any check fails; warnings do not change the exit status. See editor setup for the list of checks and the JSON report.

JSON output

--format json is accepted by check, check-project, build, emit-project, version and doctor. Every report is one JSON object on one line with schemaVersion (currently 1), action, and success or a summary. Rendered types are strings in tynix syntax and may contain newlines.

check:

{
  "schemaVersion": 1,
  "action": "check",
  "file": "hello.tynix",
  "success": true,
  "root": "String",
  "bindings": { "greeting": "String" },
  "error": null
}

On failure, success is false, root is null, bindings is empty and error holds the diagnostic, for example "3:14: [TC0013] type mismatch: 42 vs String".

check-project:

{
  "schemaVersion": 1,
  "action": "check-project",
  "projectName": "hello-tynix",
  "projectRoot": "/home/you/hello-tynix",
  "summary": { "total": 1, "ok": 1, "failed": 0 },
  "files": [
    {
      "source": "/home/you/hello-tynix/src/main.tynix",
      "relative": "main.tynix",
      "success": true,
      "root": "String",
      "bindings": { "greeting": "String" },
      "error": null
    }
  ]
}

build and emit-project have the same envelope with action set to "build" or "emit-project". Their files entries carry source, relative, runtimeOutput, declarationOutput, success and error.

version:

{ "schemaVersion": 1, "action": "version", "success": true, "version": "0.5.0.0" }

When a project cannot be loaded at all (missing or invalid config, no sources), the project commands print { "schemaVersion": 1, "action": ..., "projectRoot": ..., "projectName": ..., "success": false, "error": ... }.