Skip to Content
New to Genbox? Check out our Getting Started guide
Commandsusername

gb username

Manage your username.

Synopsis

gb username [command]

Description

Manage your Genbox username, which is used for genbox URL routing. Your username determines the URL structure for all your genboxes.

Subcommands

CommandDescription
gb usernameShow current username
gb username set <name>Set or change your username
gb username check <name>Check if a username is available

Examples

Show Current Username

gb username
Username
  Current: alice

  Your genbox URLs: https://{genbox}.app.alice.genbox.dev

If no username is set:

Username
  No username set yet

  Set your username with: gb username set <name>
  Suggested: alice123

Set Username

gb username set alice
✓ Username set to 'alice'

  Your genbox URLs: https://{genbox}.app.alice.genbox.dev

If changing existing username:

gb username set newname
? Change username from 'alice' to 'newname'? Yes
✓ Username set to 'newname'

Check Availability

gb username check alice
✓ Username 'alice' is available
gb username check admin
✗ Username 'admin' is not available
  Reason: reserved

Username Requirements

  • Minimum 3 characters
  • Lowercase letters and numbers only
  • Hyphens allowed (but not at start/end)
  • Must be unique across all users

Valid examples:

  • alice
  • alice123
  • my-team
  • dev-sandbox

Invalid examples:

  • al (too short)
  • Alice (uppercase)
  • -alice (starts with hyphen)
  • alice- (ends with hyphen)

URL Structure

Your username determines your genbox URLs:

https://{genbox-name}.app.{username}.genbox.dev

Example with username alice and genbox my-app:

https://my-app.app.alice.genbox.dev

Notes

  • Username is required before creating cloud genboxes
  • Changing username updates URLs for all your genboxes
  • Usernames cannot be the same as organization usernames
  • Some usernames are reserved (admin, api, www, etc.)

See Also

Last updated on
balanceorg