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

gb profiles

Manage Genbox profiles.

Synopsis

gb profiles [subcommand] [options] gb profiles list gb profiles show <name> gb profiles create <name>

Description

Profiles define different environment configurations. Manage, view, and create profiles for your project.

Subcommands

list

List all available profiles:

gb profiles list

Output:

Profiles in genbox.yaml: NAME SIZE APPS DATABASE DESCRIPTION admin-quick small admin none Admin UI → staging api-only medium api copy Backend services only full-stack large admin, api, web copy All apps + local DB 3 profiles defined

show

Show detailed profile configuration:

gb profiles show full-stack

Output:

Profile: full-stack Description: All apps + local database Size: large (8 vCPU, 16GB RAM) Apps: • admin → localhost:3001 • api → localhost:3050 • web → localhost:3000 Database: Mode: copy Source: staging Infrastructure: • mongodb → local • redis → local Environment: NODE_ENV=development DEBUG=true

create

Create a new profile interactively:

gb profiles create my-profile

Profile Structure

Profiles in genbox.yaml:

profiles: admin-quick: description: Admin UI only, connected to staging size: small apps: - admin default_connection: staging full-stack: description: All apps with local everything extends: admin-quick # Inherit from another profile size: large apps: - admin - api - web database: mode: copy source: staging connections: admin: api: local api: mongodb: local redis: local

Profile Inheritance

Use extends to inherit from another profile:

profiles: base: size: medium apps: [api] with-admin: extends: base apps: [admin, api] # Override apps large-stack: extends: with-admin size: large # Override size only

Using Profiles

# Create with specific profile gb create my-env --profile full-stack # Override profile settings gb create my-env --profile admin-quick --size medium

Notes

  • Default profile is used if none specified
  • extends creates inheritance chain
  • CLI flags override profile settings
  • Use gb config diff to compare profiles

See Also

Last updated on