cayu.tools.process_diagnostics

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

ProcessCommandCapabilities

from cayu.tools import ProcessCommandCapabilities

Safe discovery snapshot. Names require explicit host publication consent.

A profile ID is an application-owned public label, not a fingerprint or an execution grant. None means the application has not declared a public ID.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
policy_type	Literal['process_command_policy']	'process_command_policy'
profile_id	str | None	Field(default=None, min_length=1, max_length=128)
allowed_executables	tuple[str, ...]	Field(default=(), max_length=64)
approval_required_executables	tuple[str, ...]	Field(default=(), max_length=64)
executable_names_withheld	bool	required
allowed_env_names	tuple[str, ...]	Field(default=(), max_length=64)
environment_names_withheld	bool	required
cwd_values_state	Literal['withheld_private_paths']	'withheld_private_paths'
max_env_value_bytes	int	Field(ge=0)
allow_stdin	bool	required
max_stdin_bytes	int	Field(ge=0)
max_timeout_s	int	Field(ge=1, le=MAX_COMMAND_TIMEOUT_SECONDS)
shell_decision	Literal['allow', 'deny', 'require_command_approval']	required

Release source · Runtime guarantees · Capability guides

ProcessCommandDenialCode

from cayu.tools import ProcessCommandDenialCode

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
EXECUTABLE	class attribute	'executable'
COMMAND_KIND	class attribute	'command_kind'
SHELL	class attribute	'shell'
WORKING_DIRECTORY	class attribute	'working_directory'
ENVIRONMENT_NAME	class attribute	'environment_name'
ENVIRONMENT_VALUE_SIZE	class attribute	'environment_value_size'
ENVIRONMENT_VALUE	class attribute	'environment_value'
STDIN	class attribute	'stdin'
STDIN_SIZE	class attribute	'stdin_size'
TIMEOUT	class attribute	'timeout'
COMMAND_APPROVAL	class attribute	'command_approval'

Release source · Runtime guarantees · Capability guides

ProcessCommandDiagnostic

from cayu.tools import ProcessCommandDiagnostic

Typed correction for one refusal; never contains argv or private values.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
code	ProcessCommandDenialCode	required
rejected_name	str | None	Field(default=None, max_length=128)
value_state	Literal['published_by_policy', 'withheld_not_declared_public', 'withheld_private_value', 'not_applicable']	required
capabilities	ProcessCommandCapabilities	required

correction_hint (property)

ProcessCommandDiagnostic.correction_hint() -> str

Release source · Runtime guarantees · Capability guides