LinuxCommandLibrary

pulumi-about

Display Pulumi version and diagnostic information

TLDR

Print information about the Pulumi environment

$ pulumi about
copy

Print information about the Pulumi environment in JSON format
$ pulumi about [[-j|--json]]
copy

Print information about the Pulumi environment of a specific stack
$ pulumi about [[-s|--stack]] [stack_name]
copy

Display help
$ pulumi about [[-h|--help]]
copy

SYNOPSIS

pulumi about [flags]

PARAMETERS

--json
    Emit output as JSON, which is useful for programmatic consumption of diagnostic information.

-h, --help
    Show help for the 'about' command, detailing its usage and specific flags.

--color
    Control output colorization. Options include 'always', 'auto', 'raw', or 'never'. This is a global Pulumi flag.

--cwd
    Run pulumi as if it were executed in the specified directory. This might influence reported paths for project/stack. This is a global Pulumi flag.

--non-interactive
    Disable interactive prompts for input. While 'about' is typically non-interactive, this is a general safety flag for automation. This is a global Pulumi flag.

DESCRIPTION

The pulumi about command provides a comprehensive overview of your Pulumi CLI installation and the current operational environment. It's an indispensable tool for debugging and understanding the context in which Pulumi commands are executed. The output includes vital details such as the Pulumi CLI version, its Git SHA, the Go runtime version, the operating system and architecture. Furthermore, it details user-specific configuration like the Pulumi home directory, the currently active stack and project, and information about the configured backend (e.g., local filesystem, Pulumi Cloud, S3). This diagnostic summary is extremely valuable when troubleshooting issues or providing support, ensuring all necessary environmental variables and configurations are visible.

CAVEATS

The information provided by pulumi about is a snapshot of the current environment and configuration at the time of execution. It does not reflect changes made after the command runs or details about remote state without explicit fetching. The exact content and format of the output might slightly vary across different Pulumi CLI versions or operating systems.

KEY OUTPUT SECTIONS

The output of pulumi about typically includes sections for Pulumi CLI details (version, Git SHA, Go info), operating system and architecture, Pulumi home directory, and most importantly, the currently active project, stack, and backend information. This aggregated view is crucial for validating environment setup.

DEBUGGING AID

This command is frequently requested by Pulumi support or maintainers when diagnosing user issues, as it provides a consolidated view of the environment that might be affecting Pulumi operations.

HISTORY

The pulumi about command has been a foundational utility within the Pulumi CLI since its early development. Introduced as part of Pulumi's commitment to developer experience and diagnostic support, its primary purpose has remained consistent: to provide a quick, comprehensive snapshot of the CLI environment. As the Pulumi platform evolved, encompassing various backends and cloud providers, the 'about' command has adapted to display relevant details about the active configuration and backend, becoming an essential tool for troubleshooting and understanding the deployment context.

SEE ALSO

pulumi login(1), pulumi version(1), pulumi config(1), pulumi stack(1)

Copied to clipboard