Cua CLI API Reference

CUA CLI - Unified command-line interface for Computer-Use Agents.

main

Main entry point for CUA CLI.

print_error

def print_error(message: str) -> None

Print an error message to stderr.

create_parser

def create_parser() -> argparse.ArgumentParser

Create the main argument parser with all subcommands.

main

def main() -> int

Main entry point for the CLI.

auth

Authentication module for CUA CLI.

CredentialStore

SQLite-based credential store with WAL mode for concurrent access.

Constructor

CredentialStore(self, db_path: Path | None = None)

Attributes

Methods

CredentialStore.get

def get(self, key: str) -> Optional[str]

Get a value from the store.

Parameters:

Returns: The value, or None if not found

CredentialStore.set

def set(self, key: str, value: str) -> None

Set a value in the store.

Parameters:

CredentialStore.delete

def delete(self, key: str) -> bool

Delete a value from the store.

Parameters:

Returns: True if the key was deleted, False if it didn't exist

CredentialStore.clear

def clear(self) -> None

Clear all stored credentials.

clear_credentials

def clear_credentials() -> None

Clear all stored credentials.

get_api_key

def get_api_key() -> Optional[str]

Get the stored API key.

First checks CUA_API_KEY environment variable, then falls back to stored credentials.

Returns: The API key, or None if not found

save_api_key

def save_api_key(api_key: str) -> None

Save an API key to the credential store.

Parameters:

utils

Utility modules for CUA CLI.

run_async

def run_async(coro: Coroutine[Any, Any, T]) -> T

Run an async coroutine synchronously.

This is the standard pattern for CLI commands that need to call async code.

Parameters:

Returns: The result of the coroutine

print_error

def print_error(message: str) -> None

Print an error message to stderr.

print_info

def print_info(message: str) -> None

Print an info message.

print_json

def print_json(data: Any) -> None

Print data as formatted JSON.

print_success

def print_success(message: str) -> None

Print a success message.

print_table

def print_table(data: list[dict[str, Any]], columns: list[tuple[str, str]] | None = None, title: str | None = None) -> None

Print data as a formatted table.

Parameters:

print_warning

def print_warning(message: str) -> None

Print a warning message.