Skip to main content

atmos.support

The atmos.support function runs atmos support through the current Atmos executable. The command displays information about Atmos support options, including community resources and paid support.

Usage​

atmos.support(
    *positionals,
    flags = {},
    args = [],
    working_directory = ...,
    env = ...,
    output = "stream",
    check = True,
)

Subcommands​

The support command has no subcommands. The bare call atmos.support() runs atmos support, which prints the community and paid support options. The command takes no flags other than the help flag.

See the atmos support command reference for details.

Arguments​

*positionals

(Optional) Strings placed on the command line right after support, in order. The command does not use positional arguments. Every value must be a string.

flags

(Optional) A dictionary of command-line options; see flag translation. A bare key such as "help" becomes --help.

args
(Optional) A list or tuple of strings appended after the flags.
working_directory, env, output, check

(Optional) See atmos.run for process options and defaults.

Options other than the positionals are keyword-only.

Returns​

A result with stdout, stderr, and exit_code. See atmos.run for output and error behavior.

Examples​

Show the support options​

atmos.support()

Capture the text​

info = atmos.support(output = "capture")
print(info.stdout)

Include the support text in a failure message​

def fail_with_support(reason):
    support = atmos.support(output = "capture")
    fail(reason + "\n\n" + support.stdout)

Notes​

note

The output is written for people and describes where to find help, so calling it from a script is useful mostly for showing those links at the end of a failed run or an onboarding flow.

Related​