Skip to main content
Authenticate with an Idyl realm and create a new account. This command:
  1. Sends a verification code to your email
  2. Verifies the code to establish your identity
  3. Prompts you to accept the terms and conditions
  4. Creates a new account with you as the owner
  5. Creates a context and saves your session

​
Usage

idyl signup [flags]

​
Flags

FlagDescription
--accept-termsAccept terms and conditions (skip interactive prompt)
--account-name <string>Name for the new account
--email <string>Email address
--localhostUse localhost endpoints
-q, --quietSuppress the welcome banner and panel; print a one-line summary instead
--realm <string>Realm to signup on (default: auto-detect from config)
--subnet <string>Default subnet for the new context

​
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

​
Examples

# Interactive signup (prompts for email)
idyl signup

# Signup with specific email
idyl signup --email [email protected]

# Signup with custom account name
idyl signup --email [email protected] --account-name "My Project"

# Signup to a specific realm
idyl signup --realm dev.idyl.network --email [email protected]

# Non-interactive signup (accept terms via flag)
idyl signup --email [email protected] --accept-terms

# Connect to localhost endpoints
idyl signup --localhost