Skip to content
Text size
Text size

Packages and tools

The quickstart and task example use the 0.123.9 npm release. Keep the lockfile produced by installation. Package names still use githolon even though the framework is called Nomos.

Package Purpose
create-githolon Creates the asset starter project
githolon CLI for compilation, development, checks and deployment
@githolon/dsl TypeScript domain modelling and client generation
@githolon/runtime JavaScript peer runtime
@githolon/testing Test harness that runs a domain through the real local runtime

@githolon/client is deprecated. Its replacement is @githolon/runtime.

Package Purpose
nomos_types Shared data and protocol types
nomos_client Dart client and application lifecycle support
nomos_flutter Flutter platform host
nomos_peer_host Runtime-to-platform interfaces

The Dart packages have their own versions. Use the dependency constraints generated by the compiler and the platform package; do not assume their version numbers match npm.

Command Result
npx [email protected] my-nomos-app Creates the starter in a new directory
npm run compile Runs the project’s compilation script
npm run typecheck Checks authored TypeScript and generated declarations
npx githolon conformance Tests the installed Node toolchain using a separate bundled fixture
npx githolon conformance --offline Runs the same check with no runtime download fallback
npx githolon conformance --json Returns a structured report and a nonzero exit status on failure
npm test Runs the task example’s tests; this script is supplied by the example

For the options in your installed CLI, run npx githolon --help or npx githolon <command> --help.

Your domain’s exact client surface is in build/<name>.reception.d.mts. It defines action payloads, result types, typed references and reads. Import the corresponding .reception.mjs implementation.

For Dart output, use the generated package and its types in build/application/. Generated names depend on your model and compiler configuration.

The guides illustrate a small subset of that surface. They do not replace the declarations generated for your application.