checkmate

CLI Interface to the CheckMate tool suite.

Attributes

Classes

CheckMate

CheckMate()

Bases: BaseCLI

CheckMate task management CLI

Functions

clean

clean() -> None

Clean CheckMate tasks from persistence store.

get

get(task_id: str, verbose: bool = False) -> None

Get details of a checkmate task.

Parameters:

• task_id (str) –

  The ID of the task to retrieve.

• verbose (bool, default: False ) –

  Whether to include task metadata. Defaults to False.

Example

checkmate_cli = CheckMate()
checkmate_cli.get(task_id="12345", verbose=True)

invoke

invoke(task_id: str) -> None

Invoke / retry an existing checkmate task.

Parameters:

• task_id (str) –

  The ID of the task to invoke.

Example

checkmate_cli = CheckMate()
checkmate_cli.invoke(task_id="12345")

list

list(
    cleaned: bool | None = None,
    status: str | None = None,
    since: str | None = None,
    sort: Literal["asc", "desc"] = "desc",
    max_results: int = 100,
) -> None

List all checkmate tasks.

name classmethod

name() -> str

unlock

unlock(task_id: str) -> None

Unlock a checkmate task.

Parameters:

• task_id (str) –

  The ID of the task to unlock.

Example

checkmate_cli = CheckMate()
checkmate_cli.unlock(task_id="12345")