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

Notation

NotationMeaning
<value>Required value.
[value]Optional value.
[flags]Optional flags accepted by the command.
-n, --namespaceShort and long forms of the same flag.
KEY=VALUELiteral key-value format.

Usage

idyl

Global flags

FlagDescription
-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

Commands

Authentication

CommandDescription
idyl initInitialize Idyl CLI for a realm
idyl loginAuthenticate with Idyl
idyl logoutLog out from Idyl
idyl signupCreate a new Idyl account

Session

CommandDescription
idyl contextManage saved contexts
idyl profileView your access profiles
idyl updateCheck for CLI updates
idyl useSwitch to a different context
idyl whoamiShow current identity and context

Deploy

CommandDescription
idyl applyApply workload manifests from a file
idyl deployQuickly deploy an application
idyl runQuickly run a standalone pod for debugging/testing

Workloads

CommandDescription
idyl createCreate a workload resource
idyl deleteDelete workload resources
idyl editEdit a resource
idyl getDisplay one or many workload resources
idyl scaleSet a new size for a resource
idyl triggerManually trigger a resource
idyl waitWait for a workload resource condition

Network

CommandDescription
idyl fleetManage provider fleets
idyl nodeManage nodes
idyl regionView and manage regions
idyl snameManage subnet names
idyl subnetManage subnets

Organization

CommandDescription
idyl accountManage your account
idyl namespaceManage namespaces in your account
idyl orgManage organizations

Access Control

CommandDescription
idyl iamManage identity and access

Other

CommandDescription
idyl versionPrint version information