Elizon Docs
Elizon CLI

Install and run

Run the Elizon CLI with npx. There's nothing to install globally.

The Elizon CLI is published to npm as @elizon/cli and always runs through npx:

npx @elizon/cli <command> [options]

The first run downloads the CLI and caches it. npm installs only the build for your operating system and processor, and every later run starts from the cache.

The CLI is free to use under the Elizon CLI Licence, which you accept by running it.

Check that it works

npx @elizon/cli schema

This prints the Package manifest schema for the CLI version you just ran. It needs no project, no account and no network (beyond the first download), so it's a good first command.

To see every command:

npx @elizon/cli

With no command, the CLI prints its usage and exits with code 1.

Pin the version in a project

init records the exact CLI version a project was created with in .elizon/config.yaml:

cliVersion: 0.5.0

build refuses to run on any other version, so a Package's artifact is always built by the same toolchain. Inside a project, run the pinned version explicitly:

npx @elizon/cli@0.5.0 validate
npx @elizon/cli@0.5.0 build

The instructions init writes for coding agents already use the pinned form. To move a project to a newer CLI, see Moving to a newer CLI version.

Why a pinned version

npx @elizon/cli without a version runs whichever version npx resolves, which changes when a new release ships. Pinning makes the build reproducible: the same sources and the same CLI version always produce the same .pkg, byte for byte.

Use it in scripts

Every command accepts --json and then prints exactly one JSON document on stdout, with stable error codes and meaningful exit codes. See Output and exit codes and CI/CD.

Update or remove it

  • Update: run a newer version, e.g. npx @elizon/cli@latest init for a new project, or change a project's pin as described above. Nothing needs uninstalling first.
  • Remove: there's no global install to remove. npx keeps downloaded packages in its cache under ~/.npm/_npx (%LocalAppData%\npm-cache\_npx on Windows), and clearing that directory removes them.
  • Disconnect a machine from your Organization: revoke it in Settings → CLI Devices. The stored credential then stops working immediately.

If npx can't find a binary for your machine

The CLI is distributed as one small launcher package plus a compiled binary per platform, which npm installs as optional dependencies. If npm is configured to skip optional dependencies, the launcher has nothing to run and says:

elizon: the binary for linux-x64 is missing — npm did not install @elizon/cli-linux-x64.

Check npm config get omit. If it lists optional, remove that setting and run the command again.