Generated by
cli-reference. Never hand-edited; docs-lint L3 re-renders it and byte-compares.
CLI reference
Generated. Walked off the
clap::Commandtree by the CLI itself and byte-compared against this file on every pull request (docs-lint L3). The command tree is the only source of these pages: change the command, regenerate, never edit this file.
The root is exactly the six stages of the spine — define analyze build ship run observe — and later work adds leaves under a stage rather than a seventh root. Four stages call the studio crate that owns them as an in-process library call; two, analyze and run, have their place in the tree and no library behind them yet and say so when invoked. Hidden commands are tooling and are not listed here.
Commands
| Command | Summary |
|---|---|
labinetix | Define, analyze, build, ship, run and observe models on embedded control hardware |
labinetix define | Author, verify and release contracts in the CADB (crates/studio/define-cli) |
labinetix define sync | Regenerate views and lockfiles for one or more entities |
labinetix define verify | Recompute hashes and compare against lockfiles without writing files |
labinetix define reindex | Rebuild the aggregate store index contracts.lock.json from the entity lockfiles |
labinetix define check | CI integrity gate: emitter drift, lockfile pins, references, and policy checks |
labinetix define manifests | Schema-validate every capabilities/<id>/capability.toml in the store |
labinetix define doctor | Preflight: every declared emitter is one this binary links; the aggregate lock parses |
labinetix define list | List every entity row in the aggregate lockfile (tab-separated, script-friendly) |
labinetix define show | Show one entity’s aggregate row and key lockfile fields (tab-separated key/value lines) |
labinetix define get | Resolve a generated view path for a consumer (fail-closed hash verify by default) |
labinetix define diff | Semantic IR diff between two git refs of an entity (diagnostic; not the release baseline) |
labinetix define new | Scaffold a new entity: authoring skeleton, initial lockfile, aggregate row |
labinetix define publish | Author happy path: sync → verify → classify → version → commit |
labinetix define tag | Tag the current authoring contract_version at HEAD (no SemVer bump) |
labinetix define release | Declare a contract version, enforce the minimum SemVer bump, refresh lockfiles, and optionally tag |
labinetix analyze | Predict on the host what run will do — goldens, simulation, the compliance check |
labinetix build | Turn the target contract into the inputs a cross build needs (crates/studio/build-toolchains) |
labinetix build target | Validate the target contract and print one entry |
labinetix build cmake-toolchain | Generate a zig-cc CMake toolchain file (and its wrappers) for one target |
labinetix build verify-profile | Validate the ELF verification profiles and print one profile |
labinetix ship | Stage, activate and roll back artifacts on a target (crates/studio/ship-deploy) |
labinetix ship plan | Validate inputs and print a redacted offline deploy plan (no network) |
labinetix ship stage | Upload + independently verify both libraries under unique staging names (live untouched) |
labinetix ship activate | Install a staged pair to live paths, verify, reboot, reconnect, and post-boot verify (requires --confirm-reboot) |
labinetix ship rollback | Restore the captured prior pair, reboot, reconnect, and post-verify (requires --confirm-reboot) |
labinetix ship place-executable | Place typed test_executable artifacts under /ffx/bin_dev (no reboot; requires --confirm) |
labinetix run | Execute a model on the target engine |
labinetix observe | Record what real hardware did — on-target runs, evidence with provenance (crates/studio/observe-cli) |
labinetix observe run | Run software acceptance (scenario → deploy → remote → compare → evidence) |
labinetix observe engine-run | Validate an OPC engine run record and file it as evidence |
labinetix
Define, analyze, build, ship, run and observe models on embedded control hardware
Usage: labinetix <COMMAND>
Subcommands
| Subcommand | Summary |
|---|---|
define | Author, verify and release contracts in the CADB (crates/studio/define-cli) |
analyze | Predict on the host what run will do — goldens, simulation, the compliance check |
build | Turn the target contract into the inputs a cross build needs (crates/studio/build-toolchains) |
ship | Stage, activate and roll back artifacts on a target (crates/studio/ship-deploy) |
run | Execute a model on the target engine |
observe | Record what real hardware did — on-target runs, evidence with provenance (crates/studio/observe-cli) |
Options
| Option | Description |
|---|---|
-h, --help | Print help |
-V, --version | Print version |
labinetix define
Author, verify and release contracts in the CADB (crates/studio/define-cli)
Usage: labinetix define <COMMAND>
Subcommands
| Subcommand | Summary |
|---|---|
sync | Regenerate views and lockfiles for one or more entities |
verify | Recompute hashes and compare against lockfiles without writing files |
reindex | Rebuild the aggregate store index contracts.lock.json from the entity lockfiles |
check | CI integrity gate: emitter drift, lockfile pins, references, and policy checks |
manifests | Schema-validate every capabilities/<id>/capability.toml in the store |
doctor | Preflight: every declared emitter is one this binary links; the aggregate lock parses |
list | List every entity row in the aggregate lockfile (tab-separated, script-friendly) |
show | Show one entity’s aggregate row and key lockfile fields (tab-separated key/value lines) |
get | Resolve a generated view path for a consumer (fail-closed hash verify by default) |
diff | Semantic IR diff between two git refs of an entity (diagnostic; not the release baseline) |
new | Scaffold a new entity: authoring skeleton, initial lockfile, aggregate row |
publish | Author happy path: sync → verify → classify → version → commit |
tag | Tag the current authoring contract_version at HEAD (no SemVer bump) |
release | Declare a contract version, enforce the minimum SemVer bump, refresh lockfiles, and optionally tag |
Options
| Option | Description |
|---|---|
-h, --help | Print help |
labinetix define sync
Regenerate views and lockfiles for one or more entities.
Emitter generation defaults SOURCE_DATE_EPOCH to 0 when unset.
Usage: labinetix define sync [OPTIONS] [SELECTOR]
Arguments
| Argument | Description |
|---|---|
[SELECTOR] | Entity selector <type>/<id> (for example interface/array_adder). Mutually exclusive with --all |
Options
| Option | Description |
|---|---|
--all | Regenerate every entity in the store, in dependency-safe order, and rebuild contracts.lock.json from that walk |
--no-commit | Skip the scoped git commit (used by tests and dry runs) |
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define verify
Recompute hashes and compare against lockfiles without writing files
Usage: labinetix define verify [OPTIONS] [SELECTOR]
Arguments
| Argument | Description |
|---|---|
[SELECTOR] | Entity selector <type>/<id> |
Options
| Option | Description |
|---|---|
--all | Verify every entity in the store |
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define reindex
Rebuild the aggregate store index contracts.lock.json from the entity lockfiles.
The index is a walk of the capability tree, so this runs no emitter and touches no entity. Placement is checked while walking: an entity that does not sit where its reference chain puts it fails here exactly as it fails verify (DESIGN.md D36).
Usage: labinetix define reindex [OPTIONS]
Options
| Option | Description |
|---|---|
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define check
CI integrity gate: emitter drift, lockfile pins, references, and policy checks
Usage: labinetix define check [OPTIONS]
Options
| Option | Description |
|---|---|
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define manifests
Schema-validate every capabilities/<id>/capability.toml in the store.
The manifest is the one hand-authored file in a capability directory, and its shape is fixed by crates/studio/define-cadb/schema/capability.schema.json: the three-rung status ladder, the language vocabulary, evidence.runs, no unknown key, and status = "supported" only with a committed evidence artefact (DESIGN.md D15 rule 1). That each claim is true of the tree is a different question, answered by contract-cli/tests/capability_manifest.rs.
Usage: labinetix define manifests [OPTIONS]
Options
| Option | Description |
|---|---|
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define doctor
Preflight: every declared emitter is one this binary links; the aggregate lock parses.
An emitter is a linked crate named by a builtin: token, so there is nothing to probe and nothing to install (DESIGN.md D20, D40). For each adapters/<type>.toml that declares an [emitter], this asks the same resolver labinetix define sync dispatches on whether the declared token names an emitter this binary links and one that writes views for that contract type — so a token this accepts is a token sync can call. Then contracts.lock.json is read: a missing or unparseable aggregate lock fails.
emitter.version is reported, never compared for pass/fail. It records which emitter version wrote that type’s committed views, which need not be what the linked emitter would write today, so a stale number is printed with its repair — re-emit with labinetix define sync — instead of refusing the store (DESIGN.md D40 rule 5).
Intended for CI / local checks before full drift regen (labinetix define check).
Usage: labinetix define doctor [OPTIONS]
Options
| Option | Description |
|---|---|
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define list
List every entity row in the aggregate lockfile (tab-separated, script-friendly).
Output format: one row per entity, columns separated by TAB: type, id, contract_version, content_hash, lock_path. Rows are sorted by type then id (as stored in contracts.lock.json).
Usage: labinetix define list [OPTIONS]
Options
| Option | Description |
|---|---|
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define show
Show one entity’s aggregate row and key lockfile fields (tab-separated key/value lines).
Output format: one field per line as key<TAB>value. Includes aggregate index fields plus emitter, authoring, views, references, and source pins from the entity lockfile.
Usage: labinetix define show [OPTIONS] <SELECTOR>
Arguments
| Argument | Description |
|---|---|
<SELECTOR> | Entity selector <type>/<id> — required. |
Options
| Option | Description |
|---|---|
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define get
Resolve a generated view path for a consumer (fail-closed hash verify by default).
Prints the absolute (or repo-resolved) view path on success. With --verify-hash (documented happy path; verification is on unless --no-verify), recomputes the view byte hash and compares it to the entity lockfile — mismatch exits non-zero. --out <path> copies the verified bytes to the destination.
Usage: labinetix define get [OPTIONS] --view <VIEW> <SELECTOR>
Arguments
| Argument | Description |
|---|---|
<SELECTOR> | Entity selector <type>/<id> (for example interface/lti_ss) — required. |
Options
| Option | Description |
|---|---|
--view <VIEW> | View name from the entity lockfile / adapter (for example rust or c) — required. |
--verify-hash | Verify view bytes against the entity lockfile (documented consume path) |
--no-verify | Skip lockfile hash verification (escape hatch; not the consume happy path) |
--out <OUT> | Copy verified view bytes to this path |
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define diff
Semantic IR diff between two git refs of an entity (diagnostic; not the release baseline)
Usage: labinetix define diff [OPTIONS] <SELECTOR> <REF_A> <REF_B>
Arguments
| Argument | Description |
|---|---|
<SELECTOR> | Entity selector <type>/<id> — required. |
<REF_A> | First git ref (commit, tag, branch, or HEAD~N) — required. |
<REF_B> | Second git ref — required. |
Options
| Option | Description |
|---|---|
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define new
Scaffold a new entity: authoring skeleton, initial lockfile, aggregate row.
For an interface, --band is required and the ipo_id is allocated: the lowest id the band has never handed out, written into the authoring TOML and appended to ipo-allocations.toml as one change. An ipo_id is never chosen by hand and never reused (DESIGN.md D39).
Usage: labinetix define new [OPTIONS] <CONTRACT_TYPE> <ID>
Arguments
| Argument | Description |
|---|---|
<CONTRACT_TYPE> | Contract type (for example interface) — required. |
<ID> | Entity id (for example my_module) — required. |
Options
| Option | Description |
|---|---|
--band <BAND> | Allocation band — a [[range]] name in ipo-allocations.toml (product, demo). Required for interface, rejected otherwise |
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define publish
Author happy path: sync → verify → classify → version → commit.
Classifies against the release baseline (latest namespaced tag, else first-release from 0.0.0). Proposes the minimum SemVer unless --set overrides. Emitter generation defaults SOURCE_DATE_EPOCH to 0 when unset.
--dry-run prints the plan and never mutates authoring, lockfiles, commits, or tags.
Usage: labinetix define publish [OPTIONS] <SELECTOR>
Arguments
| Argument | Description |
|---|---|
<SELECTOR> | Entity selector <type>/<id> — required. |
Options
| Option | Description |
|---|---|
--set <SET> | Override the proposed minimum SemVer (must be >= classified minimum) |
--dry-run | Print the plan only; never mutate disk, commits, or tags |
--create-tag | Create a local annotated tag <type>/<id>/vX.Y.Z. Maintainer-only; off by default |
--push-tag | Push the created tag to origin (requires --create-tag). Maintainer-only |
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define tag
Tag the current authoring contract_version at HEAD (no SemVer bump).
Use for first cut / backfill when authoring already carries the intended version. Maintainer-only for --push.
Usage: labinetix define tag [OPTIONS] <SELECTOR>
Arguments
| Argument | Description |
|---|---|
<SELECTOR> | Entity selector <type>/<id> — required. |
Options
| Option | Description |
|---|---|
--push | Push the created tag to origin. Maintainer-only; off by default |
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix define release
Declare a contract version, enforce the minimum SemVer bump, refresh lockfiles, and optionally tag.
Classifies the semantic IR diff since the last namespaced tag (<type>/<id>/vX.Y.Z) and refuses under-bumps. Updates contract_version in authoring and lockfiles via sync. Prefer labinetix define publish for the author happy path.
--dry-run prints the plan and never mutates. --no-commit still writes authoring/lockfiles (tests / power users); do not use it as a dry-run.
Tag gate: git tags are never created unless you pass --create-tag (maintainer-only). CI and just check do not invoke this command. Agents must not pass --create-tag or --push-tag without explicit maintainer instruction.
Usage: labinetix define release [OPTIONS] --set <SET> <SELECTOR>
Arguments
| Argument | Description |
|---|---|
<SELECTOR> | Entity selector <type>/<id> — required. |
Options
| Option | Description |
|---|---|
--set <SET> | Human-declared SemVer for this release (must be >= classified minimum) — required. |
--create-tag | Create a local annotated tag <type>/<id>/vX.Y.Z. Maintainer-only; off by default |
--push-tag | Push the created tag to origin (requires --create-tag). Maintainer-only |
--no-commit | Skip the scoped git commit (still mutates authoring/lockfiles). Prefer --dry-run |
--dry-run | Print the plan only; never mutate authoring, lockfiles, commits, or tags |
--repo-root <REPO_ROOT> | Capability store root — the directory holding one directory per capability and contracts.lock.json (defaults to the current working directory) |
-h, --help | Print help (see more with ‘–help’) |
labinetix analyze
Predict on the host what run will do — goldens, simulation, the compliance check.
Not wired yet. The stage has its place in the tree and no library behind it: it will be backed by crates/studio/analyze-host-smoke, which has no library target to call today, so this command exits non-zero and names that crate rather than pretending. Host-side prediction is slice 2’s declared hard point (DESIGN.md Q21).
Usage: labinetix analyze
Options
| Option | Description |
|---|---|
-h, --help | Print help (see more with ‘–help’) |
labinetix build
Turn the target contract into the inputs a cross build needs (crates/studio/build-toolchains)
Usage: labinetix build <COMMAND>
Subcommands
| Subcommand | Summary |
|---|---|
target | Validate the target contract and print one entry |
cmake-toolchain | Generate a zig-cc CMake toolchain file (and its wrappers) for one target |
verify-profile | Validate the ELF verification profiles and print one profile |
Options
| Option | Description |
|---|---|
-h, --help | Print help |
labinetix build target
Validate hardware/targets/
With no TARGET_NAME this validates every target file and prints a summary.
Usage: labinetix build target [OPTIONS] [TARGET_NAME]
Arguments
| Argument | Description |
|---|---|
[TARGET_NAME] | Target name (for example cpxe); omit to validate and list every target |
Options
| Option | Description |
|---|---|
--format <FORMAT> | text for humans, shell for LABINETIX_* exports a build script can eval — one of text, shell; default text. |
-h, --help | Print help (see more with ‘–help’) |
labinetix build cmake-toolchain
Generate a zig-cc CMake toolchain file from hardware/targets/
With -o this also writes the executable zig-cc / zig-c++ wrappers beside it.
Usage: labinetix build cmake-toolchain [OPTIONS] <TARGET_NAME>
Arguments
| Argument | Description |
|---|---|
<TARGET_NAME> | Target name (for example cpxe) — required. |
Options
| Option | Description |
|---|---|
-o, --output <OUTPUT> | Write the toolchain file plus the zig-cc / zig-c++ wrappers here (recommended) |
--template <TEMPLATE> | Override templates/cmake-toolchain.cmake.in |
-h, --help | Print help (see more with ‘–help’) |
labinetix build verify-profile
Validate hardware/targets/verify-profiles.toml and print one profile.
The default PROFILE_NAME is the profile marked default = true.
Usage: labinetix build verify-profile [OPTIONS] [PROFILE_NAME]
Arguments
| Argument | Description |
|---|---|
[PROFILE_NAME] | Profile name; omit for the profile marked default = true |
Options
| Option | Description |
|---|---|
--format <FORMAT> | Output format — one of text, shell, json; default text. |
--triple <TRIPLE> | Resolve {triple} in artifact_subdir |
-h, --help | Print help (see more with ‘–help’) |
labinetix ship
Stage, activate and roll back artifacts on a target (crates/studio/ship-deploy)
Usage: labinetix ship [OPTIONS] [COMMAND]
Subcommands
| Subcommand | Summary |
|---|---|
plan | Validate inputs and print a redacted offline deploy plan (no network) |
stage | Upload + independently verify both libraries under unique staging names (live untouched) |
activate | Install a staged pair to live paths, verify, reboot, reconnect, and post-boot verify (requires --confirm-reboot) |
rollback | Restore the captured prior pair, reboot, reconnect, and post-verify (requires --confirm-reboot) |
place-executable | Place typed test_executable artifacts under /ffx/bin_dev (no reboot; requires --confirm) |
Options
| Option | Description |
|---|---|
--dry-run | Perform offline plan resolution without opening network sockets |
--format <FORMAT> | Output format (human or json) — one of human, json; default human. |
--output <OUTPUT> | Write report/plan output to this path (default: stdout) |
--credential-agent <CREDENTIAL_AGENT> | External credential agent program (stdout is the secret; never pass the secret in argv) |
--credential-agent-arg <CREDENTIAL_AGENT_ARGS>... | Extra argument for --credential-agent (repeatable) |
--check-credentials | Resolve and discard credentials (env / agent / prompt) without network I/O |
--work-dir <WORK_DIR> | Local working directory for transaction records (default: .local/lx-deploy) — default .local/lx-deploy. |
--transport <TRANSPORT> | Transport backend (fake for CI; cpxe for clear-text FTP/telnet on a trusted network) — one of fake, cpxe; default fake. |
--timeout-secs <TIMEOUT_SECS> | Socket timeout for CPX-E FTP/telnet (seconds) — default 30. |
--reconnect-timeout-secs <RECONNECT_TIMEOUT_SECS> | Bounded reconnect window after reboot (seconds) — default 120. |
--manifest <MANIFEST> | Path to the producer deployment-manifest.json |
--artifact-dir <ARTIFACT_DIR> | Directory containing artifact bytes named by manifest basenames |
--site-profile <SITE_PROFILE> | Path to the site profile TOML (address, username, non-secret overrides) |
--platform-profile <PLATFORM_PROFILE> | Path to the platform profile TOML (defaults to profiles/platforms/cpxe.toml) — default profiles/platforms/cpxe.toml. |
-h, --help | Print help (see more with ‘–help’) |
labinetix ship plan
Validate inputs and print a redacted offline deploy plan (no network)
Usage: labinetix ship plan [OPTIONS]
Options
| Option | Description |
|---|---|
--dry-run | Perform offline plan resolution without opening network sockets |
--format <FORMAT> | Output format (human or json) — one of human, json; default human. |
--output <OUTPUT> | Write report/plan output to this path (default: stdout) |
--credential-agent <CREDENTIAL_AGENT> | External credential agent program (stdout is the secret; never pass the secret in argv) |
--credential-agent-arg <CREDENTIAL_AGENT_ARGS>... | Extra argument for --credential-agent (repeatable) |
--check-credentials | Resolve and discard credentials (env / agent / prompt) without network I/O |
--work-dir <WORK_DIR> | Local working directory for transaction records (default: .local/lx-deploy) — default .local/lx-deploy. |
--transport <TRANSPORT> | Transport backend (fake for CI; cpxe for clear-text FTP/telnet on a trusted network) — one of fake, cpxe; default fake. |
--timeout-secs <TIMEOUT_SECS> | Socket timeout for CPX-E FTP/telnet (seconds) — default 30. |
--reconnect-timeout-secs <RECONNECT_TIMEOUT_SECS> | Bounded reconnect window after reboot (seconds) — default 120. |
--manifest <MANIFEST> | Path to the producer deployment-manifest.json |
--artifact-dir <ARTIFACT_DIR> | Directory containing artifact bytes named by manifest basenames |
--site-profile <SITE_PROFILE> | Path to the site profile TOML (address, username, non-secret overrides) |
--platform-profile <PLATFORM_PROFILE> | Path to the platform profile TOML (defaults to profiles/platforms/cpxe.toml) — default profiles/platforms/cpxe.toml. |
-h, --help | Print help (see more with ‘–help’) |
labinetix ship stage
Upload + independently verify both libraries under unique staging names (live untouched)
Usage: labinetix ship stage [OPTIONS]
Options
| Option | Description |
|---|---|
--seed-prior | Seed synthetic prior live bytes into the fake transport (demos / local smoke) |
--dry-run | Perform offline plan resolution without opening network sockets |
--format <FORMAT> | Output format (human or json) — one of human, json; default human. |
--output <OUTPUT> | Write report/plan output to this path (default: stdout) |
--credential-agent <CREDENTIAL_AGENT> | External credential agent program (stdout is the secret; never pass the secret in argv) |
--credential-agent-arg <CREDENTIAL_AGENT_ARGS>... | Extra argument for --credential-agent (repeatable) |
--check-credentials | Resolve and discard credentials (env / agent / prompt) without network I/O |
--work-dir <WORK_DIR> | Local working directory for transaction records (default: .local/lx-deploy) — default .local/lx-deploy. |
--transport <TRANSPORT> | Transport backend (fake for CI; cpxe for clear-text FTP/telnet on a trusted network) — one of fake, cpxe; default fake. |
--timeout-secs <TIMEOUT_SECS> | Socket timeout for CPX-E FTP/telnet (seconds) — default 30. |
--reconnect-timeout-secs <RECONNECT_TIMEOUT_SECS> | Bounded reconnect window after reboot (seconds) — default 120. |
--manifest <MANIFEST> | Path to the producer deployment-manifest.json |
--artifact-dir <ARTIFACT_DIR> | Directory containing artifact bytes named by manifest basenames |
--site-profile <SITE_PROFILE> | Path to the site profile TOML (address, username, non-secret overrides) |
--platform-profile <PLATFORM_PROFILE> | Path to the platform profile TOML (defaults to profiles/platforms/cpxe.toml) — default profiles/platforms/cpxe.toml. |
-h, --help | Print help (see more with ‘–help’) |
labinetix ship activate
Install a staged pair to live paths, verify, reboot, reconnect, and post-boot verify (requires --confirm-reboot)
Usage: labinetix ship activate [OPTIONS] --transaction <TRANSACTION>
Options
| Option | Description |
|---|---|
--transaction <TRANSACTION> | Transaction id from a prior successful stage (e.g. tx:…) — required. |
--confirm-reboot | Explicit destructive-action confirmation required before reboot |
--dry-run | Perform offline plan resolution without opening network sockets |
--format <FORMAT> | Output format (human or json) — one of human, json; default human. |
--output <OUTPUT> | Write report/plan output to this path (default: stdout) |
--credential-agent <CREDENTIAL_AGENT> | External credential agent program (stdout is the secret; never pass the secret in argv) |
--credential-agent-arg <CREDENTIAL_AGENT_ARGS>... | Extra argument for --credential-agent (repeatable) |
--check-credentials | Resolve and discard credentials (env / agent / prompt) without network I/O |
--work-dir <WORK_DIR> | Local working directory for transaction records (default: .local/lx-deploy) — default .local/lx-deploy. |
--transport <TRANSPORT> | Transport backend (fake for CI; cpxe for clear-text FTP/telnet on a trusted network) — one of fake, cpxe; default fake. |
--timeout-secs <TIMEOUT_SECS> | Socket timeout for CPX-E FTP/telnet (seconds) — default 30. |
--reconnect-timeout-secs <RECONNECT_TIMEOUT_SECS> | Bounded reconnect window after reboot (seconds) — default 120. |
--manifest <MANIFEST> | Path to the producer deployment-manifest.json |
--artifact-dir <ARTIFACT_DIR> | Directory containing artifact bytes named by manifest basenames |
--site-profile <SITE_PROFILE> | Path to the site profile TOML (address, username, non-secret overrides) |
--platform-profile <PLATFORM_PROFILE> | Path to the platform profile TOML (defaults to profiles/platforms/cpxe.toml) — default profiles/platforms/cpxe.toml. |
-h, --help | Print help (see more with ‘–help’) |
labinetix ship rollback
Restore the captured prior pair, reboot, reconnect, and post-verify (requires --confirm-reboot)
Usage: labinetix ship rollback [OPTIONS] --transaction <TRANSACTION>
Options
| Option | Description |
|---|---|
--transaction <TRANSACTION> | required. |
--confirm-reboot | — |
--dry-run | Perform offline plan resolution without opening network sockets |
--format <FORMAT> | Output format (human or json) — one of human, json; default human. |
--output <OUTPUT> | Write report/plan output to this path (default: stdout) |
--credential-agent <CREDENTIAL_AGENT> | External credential agent program (stdout is the secret; never pass the secret in argv) |
--credential-agent-arg <CREDENTIAL_AGENT_ARGS>... | Extra argument for --credential-agent (repeatable) |
--check-credentials | Resolve and discard credentials (env / agent / prompt) without network I/O |
--work-dir <WORK_DIR> | Local working directory for transaction records (default: .local/lx-deploy) — default .local/lx-deploy. |
--transport <TRANSPORT> | Transport backend (fake for CI; cpxe for clear-text FTP/telnet on a trusted network) — one of fake, cpxe; default fake. |
--timeout-secs <TIMEOUT_SECS> | Socket timeout for CPX-E FTP/telnet (seconds) — default 30. |
--reconnect-timeout-secs <RECONNECT_TIMEOUT_SECS> | Bounded reconnect window after reboot (seconds) — default 120. |
--manifest <MANIFEST> | Path to the producer deployment-manifest.json |
--artifact-dir <ARTIFACT_DIR> | Directory containing artifact bytes named by manifest basenames |
--site-profile <SITE_PROFILE> | Path to the site profile TOML (address, username, non-secret overrides) |
--platform-profile <PLATFORM_PROFILE> | Path to the platform profile TOML (defaults to profiles/platforms/cpxe.toml) — default profiles/platforms/cpxe.toml. |
-h, --help | Print help (see more with ‘–help’) |
labinetix ship place-executable
Place typed test_executable artifacts under /ffx/bin_dev (no reboot; requires --confirm).
Producer manifests may declare role = "test_executable" (additive field; bridge v0.3.0 plant manifests omit it — use a sidecar/overlay manifest). Destination defaults to /ffx/bin_dev/<basename> when deploy_path is empty. Never starts the binary.
Usage: labinetix ship place-executable [OPTIONS]
Options
| Option | Description |
|---|---|
--confirm | Explicit confirmation required before live-path install |
--dry-run | Perform offline plan resolution without opening network sockets |
--format <FORMAT> | Output format (human or json) — one of human, json; default human. |
--output <OUTPUT> | Write report/plan output to this path (default: stdout) |
--credential-agent <CREDENTIAL_AGENT> | External credential agent program (stdout is the secret; never pass the secret in argv) |
--credential-agent-arg <CREDENTIAL_AGENT_ARGS>... | Extra argument for --credential-agent (repeatable) |
--check-credentials | Resolve and discard credentials (env / agent / prompt) without network I/O |
--work-dir <WORK_DIR> | Local working directory for transaction records (default: .local/lx-deploy) — default .local/lx-deploy. |
--transport <TRANSPORT> | Transport backend (fake for CI; cpxe for clear-text FTP/telnet on a trusted network) — one of fake, cpxe; default fake. |
--timeout-secs <TIMEOUT_SECS> | Socket timeout for CPX-E FTP/telnet (seconds) — default 30. |
--reconnect-timeout-secs <RECONNECT_TIMEOUT_SECS> | Bounded reconnect window after reboot (seconds) — default 120. |
--manifest <MANIFEST> | Path to the producer deployment-manifest.json |
--artifact-dir <ARTIFACT_DIR> | Directory containing artifact bytes named by manifest basenames |
--site-profile <SITE_PROFILE> | Path to the site profile TOML (address, username, non-secret overrides) |
--platform-profile <PLATFORM_PROFILE> | Path to the platform profile TOML (defaults to profiles/platforms/cpxe.toml) — default profiles/platforms/cpxe.toml. |
-h, --help | Print help (see more with ‘–help’) |
labinetix run
Execute a model on the target engine.
Not wired yet. The engine (crates/device/engine-opc) runs on the device under its own supervisor and exposes no library target a host command can call, so this command exits non-zero and names it. What a real target did is read back through observe.
Usage: labinetix run
Options
| Option | Description |
|---|---|
-h, --help | Print help (see more with ‘–help’) |
labinetix observe
Record what real hardware did — on-target runs, evidence with provenance (crates/studio/observe-cli)
Usage: labinetix observe [COMMAND]
Subcommands
| Subcommand | Summary |
|---|---|
run | Run software acceptance (scenario → deploy → remote → compare → evidence) |
engine-run | Validate an OPC engine run record and file it as evidence |
Options
| Option | Description |
|---|---|
-h, --help | Print help |
labinetix observe run
Run software acceptance (scenario → deploy → remote → compare → evidence)
Usage: labinetix observe run [OPTIONS] --scenario-json <SCENARIO_JSON> --lock-json <LOCK_JSON> --lx-core-root <LX_CORE_ROOT> --plant-manifest <PLANT_MANIFEST> --plant-artifact-dir <PLANT_ARTIFACT_DIR> --executable-manifest <EXECUTABLE_MANIFEST> --executable-artifact-dir <EXECUTABLE_ARTIFACT_DIR> --executable-sha256 <EXECUTABLE_SHA256> --site-profile <SITE_PROFILE> --output-dir <OUTPUT_DIR>
Options
| Option | Description |
|---|---|
--scenario-json <SCENARIO_JSON> | CADB generated scenario.json path — required. |
--lock-json <LOCK_JSON> | CADB entity lock JSON path — required. |
--lx-core-root <LX_CORE_ROOT> | Local lx-core root containing fixtures/systems/… — required. |
--plant-manifest <PLANT_MANIFEST> | Plant producer manifest path — required. |
--plant-artifact-dir <PLANT_ARTIFACT_DIR> | Plant artifact directory — required. |
--executable-manifest <EXECUTABLE_MANIFEST> | Executable sidecar manifest path — required. |
--executable-artifact-dir <EXECUTABLE_ARTIFACT_DIR> | Executable artifact directory — required. |
--executable-sha256 <EXECUTABLE_SHA256> | Exact test-executable SHA-256 (hex, no prefix) — required. |
--site-profile <SITE_PROFILE> | Site profile path (address/username only — no password field required on argv) — required. |
--platform-profile <PLATFORM_PROFILE> | Optional platform profile override |
--output-dir <OUTPUT_DIR> | Output directory for evidence/summary/diagnostics — required. |
--timeout-secs <TIMEOUT_SECS> | Remote process timeout seconds — default 120. |
--transport <TRANSPORT> | Deploy/remote transport — one of fake, cpxe; default fake. |
--confirm-plant | Explicit confirmation for plant activate –confirm-reboot |
--confirm-place | Explicit confirmation for place-executable –confirm |
--confirm-real-remote | Required when –transport cpxe: acknowledge trusted-network real remote |
--target-token <TARGET_TOKEN> | Anonymized target token recorded in evidence (never a host/IP/user) — default target-token-local. |
--source-commit <SOURCE_COMMIT> | Host source commit for evidence provenance — default unknown. |
--run-token <RUN_TOKEN> | Per-run cleanup token (never a secret) |
--remote-address <REMOTE_ADDRESS> | Target address for real remote (ignored for fake) |
--remote-user <REMOTE_USER> | Target username for real remote (ignored for fake) |
-h, --help | Print help (see more with ‘–help’) |
labinetix observe engine-run
Validate an OPC engine run record and file it as evidence
Usage: labinetix observe engine-run [OPTIONS] --record <RECORD>
Options
| Option | Description |
|---|---|
--record <RECORD> | The record the engine wrote (--run-record on the device) — required. |
--capabilities-root <CAPABILITIES_ROOT> | Repository capabilities/ directory — default capabilities. |
--evidence-version <EVIDENCE_VERSION> | Evidence bundle version directory, e.g. v0.1.0 — default v0.1.0. |
--file | File the record under the capability it names. Without this, validate and report only |
-h, --help | Print help |