Skip to main content
Manage subnet names (snames). An sname is a globally unique, human-readable alias that can be bound to a subnet slug — like a CNAME for subnets. Subnet names are purchased in the Idyl console. This CLI manages names after purchase.

Usage

idyl sname

Commands

CommandDescription
idyl sname bindBind a name to a subnet
idyl sname getGet subnet name details or list all
idyl sname releaseRelease a subnet name
idyl sname transferTransfer a name to another account
idyl sname unbindUnbind a name from its subnet

Inherited 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

Examples

# List owned names
idyl sname list

# Bind a name to a subnet
idyl sname bind my-app --subnet 100000000001

# Unbind a name
idyl sname unbind my-app

# Transfer a name to another account
idyl sname transfer my-app --to-account-id <account-id>

# Release a name
idyl sname release my-app

Subcommand reference

idyl sname bind

Point a subnet name at a subnet slug.

Usage

idyl sname bind <name> --subnet <slug> [flags]

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.
--subnet <string>Required. Subnet slug to bind the name to

Examples

# Bind a name to a subnet
idyl sname bind my-app --subnet 100000000001

idyl sname get

Get details of a specific subnet name, or list all owned names.

Usage

idyl sname get [name] [flags]

Aliases

  • list
  • ls

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.

Examples

# List all owned names
idyl sname get
idyl sname list
idyl sname ls

# Get a specific name
idyl sname get my-app

# JSON output
idyl sname get -o json
idyl sname get my-app -o json

idyl sname release

Release (delete) a subnet name, making it available for others. You will be prompted for confirmation unless the —yes flag is provided.

Usage

idyl sname release <name> [flags]

Flags

FlagDescription
-y, --yesSkip confirmation prompts

Examples

# Release a name (with confirmation)
idyl sname release my-app

# Release without confirmation
idyl sname release my-app --yes

idyl sname transfer

Transfer ownership of a subnet name to another account.

Usage

idyl sname transfer <name> --to-account-id <account-id> [flags]

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.
--to-account-id <string>Required. Account ID to transfer the name to

Examples

# Transfer a name
idyl sname transfer my-app --to-account-id 550000000001

idyl sname unbind

Detach a subnet name from its currently bound subnet.

Usage

idyl sname unbind <name> [flags]

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.

Examples

# Unbind a name
idyl sname unbind my-app