Getting started

Overview

Jaiph is a workflow system for building agent-style pipelines. You write .jh sources (and optional *.test.jh test modules) that combine prompts, rules, scripts, and workflows.

This page is a map: it does not teach syntax end-to-end; it points to install steps, language references, and runtime behavior. For how the tool fits together, see Architecture.

Setup

• Setup and installation — Install the CLI, run a one-liner sample without cloning, execute workflows, format sources, and initialize a project with .jaiph/ and workspace conventions.
• Libraries — Install git-based .jh modules under .jaiph/libs/, pin versions with a lockfile, and import them with the library-name/module path form.

Language

• Language — Practical guide to rules, scripts, prompts, workflows, and imports, with patterns you can copy.
• Inbox & Dispatch — Named channels and send for routing work between workflows without tight coupling.
• Testing — *.test.jh suites, mocks, and assertions for deterministic checks around workflows.
• Spec: Async Handles — Handle<T> resolution, implicit join, and interaction with run async.
• Grammar — Formal syntax, types, and step contracts for the whole surface area.

Runtime

• CLI — jaiph run, test, compile, format, init, install, use, flags, and environment variables.
• Configuration — config { } blocks, agent backends, logging, and runtime options (including env overrides).
• Runtime artifacts — What Jaiph writes under .jaiph/runs/ (per-step logs, JSONL timeline, inbox files) versus live progress on stderr.
• Hooks — Project or user hooks.json to run shell commands on workflow and step lifecycle events.
• Sandboxing — Optional Docker-backed workflow isolation (beta; opt-in through runtime.* keys in module config and environment—see Configuration).

Other

• VS Code extension — Syntax highlighting, formatting, and compile feedback in the editor.
• Architecture — How the CLI, parser, transpiler, Node runtime, and contracts fit together; aimed at contributors and deep dives.
• Contributing — Clone-and-build workflow, branch strategy, test layers, and how to propose changes.
• Agent Skill — Short, opinionated defaults for AI assistants authoring and running Jaiph in a repo.
• Examples — Runnable samples (async, inbox, testing, recovery) alongside the main tree.