Command reference - IDYL Docs

Use this reference when you need exact command syntax. For CLI setup and usage concepts, start with the CLI user guide.

Notation

Notation	Meaning
`<value>`	Required value.
`[value]`	Optional value.
`[flags]`	Optional flags accepted by the command.
`-n`, `--namespace`	Short and long forms of the same flag.
`KEY=VALUE`	Literal key-value format.

idyl [flags]

Flag	Description
`-a <string>, --account-id <string>`	Account ID to use, overriding the current context.
`-c <string>, --context <string>`	Use the named context for this command.
`-h, --help`	Show help for a command.
`--homedir <string>`	Override the configuration directory. Defaults to ~/.config/idyl.
`-n <string>, --namespace <string>`	Namespace to address, overriding the entered context.
`--network <string>`	Override the Network for this command.
`-p <string>, --profile <string>`	Override the access profile for this command.
`-s <string>, --subnet <string>`	Subnet to use for this command, overriding the current context.
`--workspace <string>`	Workspace within the namespace, overriding the entered context.

Command	Description
`idyl apply`	Apply resource manifests from a file
`idyl deploy`	Deploy an application from the command line
`idyl file`	Manage files in the entered workspace
`idyl run`	Manage durable runs in the entered workspace

Command	Description
`idyl create`	Create a resource
`idyl delete`	Delete resources
`idyl edit`	Edit a resource
`idyl get`	List and inspect resources
`idyl purge`	Permanently purge deleted credential and Vault resources
`idyl rotate`	Rotate workload Vault resources
`idyl scale`	Change the replica count of a workload
`idyl trigger`	Manually trigger a resource
`idyl wait`	Wait for a resource condition

Command	Description
`idyl exec`	Run a command in a workload container
`idyl logs`	Show logs from a workload container
`idyl ssh`	Connect to a workload with OpenSSH

Command	Description
`idyl cloud-account`	Manage connected cloud accounts
`idyl fleet`	Manage provider fleets
`idyl fleet-lease`	Manage leased fleet capacity
`idyl node`	Manage nodes
`idyl region`	View and manage regions
`idyl subnet`	Manage subnets

Command	Description
`idyl account`	Manage your account
`idyl iam`	Manage identity and access
`idyl namespace`	Manage namespaces in your account
`idyl org`	Manage organizations
`idyl workspace`	Manage workspaces in a namespace

Command	Description
`idyl context`	Manage saved contexts
`idyl init`	Initialize the IDYL CLI for a Network
`idyl login`	Authenticate with IDYL
`idyl logout`	Log out from IDYL
`idyl profile`	View your access profiles
`idyl signup`	Create a new IDYL account
`idyl use`	Enter a namespace or a workspace within it
`idyl whoami`	Show current identity and context

Command	Description
`idyl update`	Check for CLI updates
`idyl version`	Print version information