Skip to content

Process

provide.foundation.cli.commands.process

TODO: Add module docstring.

Functions

get_title_command 

get_title_command() -> None

Get the current process title.

Displays the current process title as it appears in process listings.

Example

foundation process get-title

Source code in provide/foundation/cli/commands/process.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
@process_group.command("get-title")
@requires_click
@with_cleanup
def get_title_command() -> None:
    """Get the current process title.

    Displays the current process title as it appears in process listings.

    Example:
        foundation process get-title
    """
    _get_title_impl()

info_command 

info_command() -> None

Show process title support information.

Displays whether process title support is available and the current process title if supported.

Example

foundation process info

Source code in provide/foundation/cli/commands/process.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
@process_group.command("info")
@requires_click
@with_cleanup
def info_command() -> None:
    """Show process title support information.

    Displays whether process title support is available and the current
    process title if supported.

    Example:
        foundation process info
    """
    _info_impl()

process_group 

process_group() -> None

Process management commands.

Commands for managing process titles and process information. Requires the 'process' extra: pip install 'provide-foundation[process]'

Source code in provide/foundation/cli/commands/process.py 
70
71
72
73
74
75
76
77
@click.group("process")
def process_group() -> None:
    """Process management commands.

    Commands for managing process titles and process information.
    Requires the 'process' extra: pip install 'provide-foundation[process]'
    """
    pass

set_title_command 

set_title_command(title: str) -> None

Set the current process title.

The process title appears in process listings (ps, top, etc.) and helps identify processes in monitoring tools.

Example

foundation process set-title "my-worker-1"

Source code in provide/foundation/cli/commands/process.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
@process_group.command("set-title")
@click.argument("title")
@requires_click
@with_cleanup
def set_title_command(title: str) -> None:
    """Set the current process title.

    The process title appears in process listings (ps, top, etc.) and helps
    identify processes in monitoring tools.

    Example:
        foundation process set-title "my-worker-1"
    """
    _set_title_impl(title)