Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Friday CLI Components

Reusable Rich and Prompt Toolkit components for terminal applications: display, input, commands, configuration and session lifecycle. For the supported Friday chat application, install and run Friday Chat.

Distribution: friday-framework-cli · Import: friday_cli Python: 3.13.4+ · Status: alpha · License: MIT

Installation

python -m pip install "friday-framework-cli==0.1.0a4"

Friday distributions use the same release version; keep internal Friday dependencies aligned.

Quick start: display structured output

from friday_cli import display_success, display_table, spinner

display_success("Application ready")
display_table([{"package": "friday-cli", "status": "ready"}], title="Components")
with spinner("Preparing session") as status:
    status.update("Prepared")

This only renders terminal output. It makes no model requests and does not start an interactive session.

Choose a component

Surface Public entry points
Console and display get_console, set_console, display_error, display_json, display_table, display_panel
Progress spinner, progress_bar, ProgressTracker
Interactive input InputHandler, CommandCompleter
Slash commands CommandRegistry, arg
Session lifecycle SessionConfig, SessionManager, managed_session
Theme configuration CLIConfig, load_cli_config, reset_console
Cancellation CancellationToken, CancellableContext, run_cancellable

InputHandler needs a suitable interactive terminal. A command registry parses and dispatches your handlers; it does not create an agent or grant permissions to its commands. Use SessionManager for owned session startup/shutdown and keep session factories application-specific.

Configuration and application choice

cli-config.yaml configures theme colors, status icons and prompts. Load it through load_cli_config and rebuild the console with reset_console when changing an existing console. Runtime/model/tool configuration belongs to the application, not the terminal theme.

The package metadata declares a historical friday console entry point, but friday_cli.main currently contains only a placeholder: that executable is not a working application entry point. Use friday-chat --help for the maintained chat CLI. Legacy container, REPL and server modules remain compatibility surfaces; prefer friday_runtime.RuntimeKernel for new headless applications.

Development

Work from the monorepo root after the shared contributor setup. Run the focused suite:

uv run --no-sync pytest packages/friday-cli/tests_cli -q

Documentation and support

Chat application · Runtime composition · Theme configuration · Source · Issues · Contributing

License

MIT.

Metadata

Release files for friday-framework-cli 0.1.0a4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for friday-framework-cli 0.1.0a4
File Size Uploaded Provenance Actions
friday_framework_cli-0.1.0a4.tar.gz 37.9 kB Without provenance Details for friday_framework_cli-0.1.0a4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for friday-framework-cli 0.1.0a4
File Interpreter ABI Platform Actions
friday_framework_cli-0.1.0a4-py3-none-any.whl Python 3 none any Details for friday_framework_cli-0.1.0a4-py3-none-any.whl

Total release size: 71.1 kB

Release files / friday_framework_cli-0.1.0a4.tar.gz

Download URL friday_framework_cli-0.1.0a4.tar.gz
Size 37.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3721be1c8c88f4d02dcea339de20331bf3c6f92b014bafbc60510a2b426a6514
BLAKE2b-256 checksum
How to use checksums
5662e0126918f839bab16d84eee5647b6abff27d2ddca38e2cc89c5aa10af947
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / friday_framework_cli-0.1.0a4-py3-none-any.whl

Download URL friday_framework_cli-0.1.0a4-py3-none-any.whl
Size 33.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9b0e3bc2deac50a49a841d2a9c779979c6e1847e83a7b9072b192d3d9e117ee3
BLAKE2b-256 checksum
How to use checksums
6537b0b84bab326313e87b5c0a88e876750eb0fcd3327f0c47c4950406d8801f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for friday-framework-cli 0.1.0a4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page