Skip to main content

Module actions

Module actions 

Source
Expand description

Actions — the shared verb layer (ARCHITECTURE.md layering invariant: CLI handlers and, from Phase 6, the TUI both call these).

Actions NEVER print — they return serde models; rendering belongs to the binary (and later the TUI).

Modules§

adopt
The adopt action (ADOPT-02) — one idempotent verb that walks a commissioned-but-unadopted gateway to a fully working profile: native login → API-key mint (idempotent by name) → permissions wiring → live probe → credential persistence.
apicall
The raw api-call action (09-03, EXT-01) — ign api call’s verb layer: the usage guards run HERE too (in-process callers cannot skip them; main.rs runs them even EARLIER, pre-resolve, so the failure envelope’s profile is null and zero construction happens), then the client passthrough and the envelope outcome model.
backup
Standalone gwbk backup actions (07-02, BKUP-01) — the Phase 4 client methods surfaced on ANY profiled gateway (not just rigs).
connections
Connection actions (02-03, HLTH-05/06): DB/OPC connection status — serde models OUT, no printing. Mirrors super::sessions: both family keys are ALWAYS present in the data shape; a filter excludes without calling the other endpoint.
diagnostics
Diagnostics-bundle actions (09-05, EXT-02; 09-07 Invalid semantics) — generate / status / wait / download over the wire landed in this phase.
doctor
The doctor action (02-05, HLTH-10) — the self-service preflight: one structured checks[] report diagnosing URL, liveness, commissioning, auth (401-vs-403 made specific via the security-properties deep-dive), write permission, WebDev-route presence, and rig presence. Serde models OUT, no printing.
eam
EAM task actions (07-02, BKUP-02) — the read-heavy surface with guarded writes, now carrying the full write LIFECYCLE (10-03). Reads: run history (the runtime seam — the controller state gate classifies honestly) and task definitions (the config-resource seam — available on stock gateways). Writes: create (the guard ladder), suspend/resume/cancel (find-first lifecycle verbs), modify (full-record RMW) and delete (signature-keyed) — every verb preceded by the blast-radius preview composer (build_blast_radius) when the caller needs the pre-flight.
edit
ign edit core — the Editor seam, the private edit tree, and the edit pipeline (13-05).
gan
ign gan status action (09-04, EXT-02) — a thin wrapper over the GAN overview read (the redundancy wrapper pattern; {status: …} keeps the render arms symmetrical).
inspect
Inspection actions (02-02, HLTH-01/02/07): status, modules, metrics — serde models OUT, no printing (ARCHITECTURE.md layering: the Phase-6 TUI rides this same layer).
license
ign license status action (09-04, EXT-02) — the morning-check MERGE: the /data/api/v1/licenses inventory read plus the trial companion (/data/api/v1/trialTrialWire + its capability method, already live-proven in Phase 4; zero new trial code).
lint
ign lint — external ignition-lint delegation (07-04, INTR-02).
logs
Log actions (02-04, HLTH-03/04): the poll-based TAIL loop — serde models and a sink OUT, no printing (ARCHITECTURE.md layering: the Phase-6 TUI rides this same layer).
profile
profile add/list/use actions — pure config operations, no printing, serde models out (declaration order = golden field order).
projects
Project actions (03-01, PROJ-01/02): list with inheritance info, new, copy, rename, set (reparent), delete — serde models OUT, no printing (ARCHITECTURE.md layering: the Phase-6 TUI rides this same layer).
redundancy
ign redundancy status action (09-04, EXT-02) — a thin wrapper over the redundancy read. The wrapper indirection keeps the render arms symmetrical with the license merge ({status: …} envelope shape for the single-read families).
resources
Resource actions (05-02 re-point): the surgical edit loop — list/get/put/delete ONE resource inside a project — riding project-export ZIP surgery instead of the nonexistent /projects/{p}/resources/** REST routes (the Phase 3 cross-phase defect, closed here; 05-RESEARCH §Resource Family Decision). Serde models OUT, no printing (ARCHITECTURE.md layering: the Phase-6 TUI rides this same layer).
restart
Restart + wait actions (02-05, HLTH-09/11) — built on the ONE wait engine (crate::poll, 02-04): serde models OUT, no printing.
rig
Rig lifecycle actions (04-01, RIG-01): up / down / status — serde models OUT, no printing (the TUI rides this layer in Phase 6). Extended by 04-02 (reset/logs), 04-03 (trial), 04-04 (snapshot/restore, RIG-04).
script
The script action (07-03, SCRPT-01) — ign script run, the smallest verb in the CLI: one action over the already-shipped, already-secured scriptExec route (05-01’s template, 05-03’s deploy/secret lifecycle).
sessions
Session actions (02-03, HLTH-08): merged list + terminate — serde models OUT, no printing (ARCHITECTURE.md layering: the Phase-6 TUI rides this same layer).
tag_loss
TAGS-12 loss-report advisory scans (11-03).
tags
Tag actions (05-04..05-06) — serde models OUT, no printing.
version
version action — CLI version always, gateway check when a client was injected, implementing the LOCKED behavior matrix (research Pattern 6):
webdev
The WebDev deploy/status actions (05-03, WEB-01 + WEB-02) — the hinge layer every tag command in 05-04..06 rides.
workspace
Workspace actions (13-03) — the .ign-workspace.json manifest (the three-way-compare state for ign workspace status/push, 13-06) and the checkout action that turns a gateway project export into a mapped, hash-recorded local directory tree.