Usage
Aliases
nodes
Commands
| Command | Description |
|---|---|
idyl node config | Manage this machine’s local node config |
idyl node get | List nodes in subnet, or get one’s details |
idyl node id | Show this machine’s local node identity |
idyl node init | Prepare this machine as a local provider node |
idyl node join | Join this machine as a provider node |
idyl node logs | Show local node service logs |
idyl node reset | Delete local node identity and state |
idyl node run-service | Run idyld under the local service wrapper |
idyl node service | Plan and validate production node service installation |
idyl node start | Install and start the local node service |
idyl node status | Show local node status |
idyl node stop | Stop the local node service |
idyl node uninstall-service | Remove the local node service integration |
Inherited flags
| Flag | Description |
|---|---|
-a <string>, --account-id <string> | Account ID to use (overrides context) |
-c <string>, --context <string> | Use specific context |
--homedir <string> | Override config directory (default: ~/.idyl) |
-n <string>, --namespace <string> | Namespace to use |
-o <string>, --output <string> | Output format (json|yaml) |
-p <string>, --profile <string> | Override profile |
--realm <string> | Override realm |
--subnet <string> | Override context subnet for this command |
Examples
Subcommand reference
idyl node config
Manage this machine’s local node config.
The local node config stores non-secret service state, the node realm, and
contribution limits. Contribution limits are local safety caps: they define the
maximum CPU, memory, GPU, and ephemeral disk capacity this machine is willing to
make available to IDYL.
Usage
Commands
| Command | Description |
|---|---|
idyl node config get | Show this machine’s local node config |
idyl node config set | Update this machine’s local node config |
Examples
idyl node config get
Show this machine’s local node config, contribution limits, and local config paths.
Usage
Aliases
show
Flags
| Flag | Description |
|---|---|
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
idyl node config set
Update this machine’s local node config.
Set the local node realm or one or more local safety caps for the maximum CPU,
memory, GPU, and ephemeral disk capacity this machine is willing to make
available to IDYL. Changes are written locally and apply the next time the node
service starts.
Usage
Flags
| Flag | Description |
|---|---|
--containerd-address <string> | containerd socket address for containerd profiles or raw containerd provider config |
--containerd-kata-config-path <string> | Kata runtime config path for Kata profiles or raw Kata provider config |
--containerd-kata-vmm-backend <string> | Expected Kata VMM backend for raw Kata provider config or advanced profile overrides: qemu or firecracker |
--containerd-namespace <string> | containerd namespace for containerd profiles or raw containerd provider config |
--containerd-runtime-type <string> | containerd runtime type for raw provider config; cannot be combined with —runtime-profile |
--limit-cpu <string> | Maximum CPU this node may contribute, such as 1, 2, or 500m |
--limit-disk <string> | Maximum ephemeral disk this node may contribute, such as 10Gi, 100Gi, or 500Gi |
--limit-gpu <string> | Maximum GPU capacity this node may contribute, such as 1, nvidia:1, or h100:2 |
--limit-memory <string> | Maximum memory this node may contribute, such as 256Mi, 1Gi, or 8Gi |
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
--runtime-profile <string> | Named local runtime preset; selects provider, runtime type, and explicit Kata backend when applicable (docker, containerd-runc, containerd-kata-qemu, containerd-kata-firecracker) |
--runtime-provider <string> | Raw local runtime provider when not using —runtime-profile: docker or containerd Default: docker. |
Examples
idyl node get
List nodes in the current subnet, or get details of a specific node.
With no arguments, lists connected nodes in the subnet.
With a node ID argument, gets details of that specific node.
Usage
Aliases
listls
Flags
| Flag | Description |
|---|---|
--all | Include disconnected nodes |
--limit <int> | Maximum number of nodes to list Default: 100. |
--offset <int> | Number of nodes to skip Default: 0. |
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
-s <string>, --subnet <string> | Subnet name or slug (overrides context) |
-w, --watch | Watch for changes to nodes |
Examples
idyl node id
Show this machine’s local node identity without creating server-side state.
Usage
Flags
| Flag | Description |
|---|---|
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
idyl node init
Prepare this machine as a local provider node without joining IDYL.
The command creates this machine’s local node identity and local node config if
they do not already exist. The local config records the node realm and can also
record contribution limits for the maximum CPU, memory, GPU, and ephemeral disk
capacity this machine is willing to make available to IDYL.
If —realm is omitted, the command uses the active CLI context realm, or the
only initialized realm when exactly one realm is configured.
The command does not register ownership, join a fleet, join a subnet, request
admission, or start the local node service.
Usage
Flags
| Flag | Description |
|---|---|
--containerd-address <string> | containerd socket address for containerd profiles or raw containerd provider config |
--containerd-kata-config-path <string> | Kata runtime config path for Kata profiles or raw Kata provider config |
--containerd-kata-vmm-backend <string> | Expected Kata VMM backend for raw Kata provider config or advanced profile overrides: qemu or firecracker |
--containerd-namespace <string> | containerd namespace for containerd profiles or raw containerd provider config |
--containerd-runtime-type <string> | containerd runtime type for raw provider config; cannot be combined with —runtime-profile |
--limit-cpu <string> | Maximum CPU this node may contribute, such as 1, 2, or 500m |
--limit-disk <string> | Maximum ephemeral disk this node may contribute, such as 10Gi, 100Gi, or 500Gi |
--limit-gpu <string> | Maximum GPU capacity this node may contribute, such as 1, nvidia:1, or h100:2 |
--limit-memory <string> | Maximum memory this node may contribute, such as 256Mi, 1Gi, or 8Gi |
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
--runtime-profile <string> | Named local runtime preset; selects provider, runtime type, and explicit Kata backend when applicable (docker, containerd-runc, containerd-kata-qemu, containerd-kata-firecracker) |
--runtime-provider <string> | Raw local runtime provider when not using —runtime-profile: docker or containerd Default: docker. |
Examples
idyl node join
Join this machine as a provider node.
The command creates or loads the local node identity, asks the account API for
an enrollment challenge, signs that exact challenge locally, and completes the
account-scoped enrollment flow. The private key never leaves this machine.
Use —runtime-profile for named presets. A profile expands to the provider,
runtime type, and default local runtime settings. Use —runtime-provider only
when you are not using a profile and need raw runtime settings. Profiles and
—runtime-provider cannot be combined.
The docker and containerd-runc profiles report container isolation.
containerd-kata-qemu and containerd-kata-firecracker report microvm isolation
and pin the Kata VMM backend. Joining a subnet does not by itself prove
compatibility with subnet runtime policy; compatibility is enforced when
capacity is reported and workloads are scheduled.
Usage
Flags
| Flag | Description |
|---|---|
--containerd-address <string> | containerd socket address for containerd profiles or raw containerd provider config |
--containerd-kata-config-path <string> | Kata runtime config path for Kata profiles or raw Kata provider config |
--containerd-kata-vmm-backend <string> | Expected Kata VMM backend for raw Kata provider config or advanced profile overrides: qemu or firecracker |
--containerd-namespace <string> | containerd namespace for containerd profiles or raw containerd provider config |
--containerd-runtime-type <string> | containerd runtime type for raw provider config; cannot be combined with —runtime-profile |
--fleet <string> | Fleet ID for fleet-based provider admission |
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
--runtime-profile <string> | Named local runtime preset; selects provider, runtime type, and explicit Kata backend when applicable (docker, containerd-runc, containerd-kata-qemu, containerd-kata-firecracker) |
--runtime-provider <string> | Raw local runtime provider when not using —runtime-profile: docker or containerd Default: docker. |
--start | Start the local node service after admission |
--subnet <string> | Subnet name or slug for daemon placement and provider admission |
Examples
idyl node logs
Show local node service logs
Usage
Flags
| Flag | Description |
|---|---|
--follow | Follow logs Default: true. |
--lines <int> | Number of log lines to show Default: 100. |
idyl node reset
Delete local node identity and state
Usage
Flags
| Flag | Description |
|---|---|
--dangerous | Confirm that local node identity and state should be deleted |
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
-y, --yes | Skip confirmation prompts |
idyl node run-service
Run idyld under the local service wrapper
Usage
idyl node service
Plan and validate production Linux system service installation for the local node daemon. The current command group is report-only.
Usage
Commands
| Command | Description |
|---|---|
idyl node service plan | Render a production node service installation plan |
idyl node service validate | Validate a production node service plan |
idyl node service plan
Render a production Linux system service installation plan for idyld.
This command is plan-only. It does not install packages, create users or groups,
write systemd units, change file ownership, chmod host paths, alter runtime
socket permissions, or start services.
Usage
Flags
| Flag | Description |
|---|---|
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
--production | Render the production Linux system service model |
--runtime-profile <string> | Production runtime profile: docker, containerd-runc, containerd-kata-qemu, or containerd-kata-firecracker |
Examples
idyl node service validate
Validate the production Linux system service plan for idyld.
This command is validation-only. It does not install packages, create users or
groups, write systemd units, change file ownership, chmod host paths, alter
runtime socket permissions, or start services.
Usage
Flags
| Flag | Description |
|---|---|
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
--production | Validate the production Linux system service model |
--runtime-profile <string> | Production runtime profile: docker, containerd-runc, containerd-kata-qemu, or containerd-kata-firecracker |
Examples
idyl node start
Install and start the local node service
Usage
Flags
| Flag | Description |
|---|---|
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
idyl node status
Show local node identity status. Remote admission status is not inferred from local files.
Usage
Flags
| Flag | Description |
|---|---|
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
idyl node stop
Stop the local node service
Usage
Flags
| Flag | Description |
|---|---|
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |
idyl node uninstall-service
Remove the local node service integration
Usage
Flags
| Flag | Description |
|---|---|
-o <string>, --output <string> | Output format: table, json, yaml Default: table. |