Skip to main content

atmos profile show

Use this command to display detailed information about a specific configuration profile, including its metadata, configuration files, and usage instructions.

atmos profile show developer

Usage​

atmos profile show <profile-name> [flags]

Arguments​

profile-name

Required. The name of the profile to inspect.

Use atmos profile list to see available profiles.

Description​

Show detailed information about a specific configuration profile.

The output includes:

  • Profile location and type: Where the profile is defined and whether it's inline or directory-based
  • Metadata: Name, description, version, and tags
  • Configuration files: List of YAML files that make up the profile
  • Usage instructions: How to activate the profile

Flags​

-f, --format

Output format. Options: text, json, yaml

Default: text

Examples​

Show Profile Details​

# Show details of the 'developer' profile
atmos profile show developer

Example output:

Profile: developer
══════════════════════════════════════════════════════════════════════════════

Location:    profiles/developer
Type:        directory
Description: Development environment with debug logging

Metadata
────────────────────────────────────────────────────────────────────────────────
  Version:  1.0.0
  Tags:     dev, local, debug

Configuration Files
────────────────────────────────────────────────────────────────────────────────
  • atmos.yaml
  • auth.yaml

Usage
────────────────────────────────────────────────────────────────────────────────
  atmos --profile developer <command>
  ATMOS_PROFILE=developer atmos <command>

Output as JSON​

# Show profile details in JSON format
atmos profile show developer --format json

Example output:

{
  "name": "developer",
  "type": "directory",
  "source": "profiles/developer",
  "description": "Development environment with debug logging",
  "version": "1.0.0",
  "tags": ["dev", "local", "debug"],
  "files": [
    "atmos.yaml",
    "auth.yaml"
  ]
}

Output as YAML​

# Show profile details in YAML format
atmos profile show developer --format yaml

Example output:

name: developer
type: directory
source: profiles/developer
description: Development environment with debug logging
version: "1.0.0"
tags:
  - dev
  - local
  - debug
files:
  - atmos.yaml
  - auth.yaml

Show Inline Profile​

# Show an inline profile defined in atmos.yaml
atmos profile show production

Example output:

Profile: production
══════════════════════════════════════════════════════════════════════════════

Location:    atmos.yaml
Type:        inline
Description: Production configuration

Configuration
────────────────────────────────────────────────────────────────────────────────
  logs:
    level: Warning
  settings:
    terminal:
      color: false

Usage
────────────────────────────────────────────────────────────────────────────────
  atmos --profile production <command>
  ATMOS_PROFILE=production atmos <command>

Error Handling​

Profile Not Found​

If the specified profile doesn't exist, you'll see a helpful error message:

atmos profile show nonexistent
Error: Profile not found

Profile 'nonexistent' does not exist in any configured location.

Hints:
  • Run 'atmos profile list' to see all available profiles
  • Check the spelling of the profile name
  • Verify 'profiles.base_path' in 'atmos.yaml' if using custom location

Context:
  profile: nonexistent
  command: profile show

Scripting Examples​

Get Profile Description​

# Extract just the description
atmos profile show developer --format json | jq -r '.description'

Check Profile Version​

# Get the version of a profile
atmos profile show developer --format json | jq -r '.version // "not specified"'

List Configuration Files​

# Get list of files in a profile
atmos profile show developer --format json | jq -r '.files[]'

See Also​