diff --git a/README.md b/README.md index 5b8ea5c..764f664 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)]() -Official command-line interface for [OpenWebUI](https://github.com/open-webui/open-webui). +A command-line interface for [OpenWebUI](https://github.com/open-webui/open-webui). + +> **Note:** This is a community project proposing what an official CLI could look like. Not currently affiliated with or endorsed by the OpenWebUI team. See `docs/RFC.md` for the full proposal. > Status: Alpha (v0.1.0) — tested, linted, ~90% coverage. Known limitations: OAuth/provider login and API key management are not implemented yet; models pull/delete depend on server support. @@ -171,6 +173,8 @@ pytest tests/ --cov=openwebui_cli MIT License - see [LICENSE](LICENSE). +> **Note on license:** OpenWebUI itself uses a modified BSD-3-Clause license with branding requirements. This CLI uses MIT for simplicity as a community tool. If the OpenWebUI team were interested in official adoption, we'd happily relicense to match their terms. + ## Credits Created and maintained by **Danny Stocker** at [if.](https://digital-lab.ca/dannystocker/) diff --git a/docs/RFC.md b/docs/RFC.md index a06beff..3b18a82 100755 --- a/docs/RFC.md +++ b/docs/RFC.md @@ -1,16 +1,22 @@ -# OpenWebUI Official CLI - RFC Proposal +# OpenWebUI CLI - RFC Proposal **Document Version:** 1.2 **Date:** November 30, 2025 -**Author:** InfraFabric Team +**Author:** InfraFabric Team / Danny Stocker **Target:** OpenWebUI Core Team Review -**Status:** DRAFT - Reviewed & Implementation-Ready +**Status:** DRAFT - Community Proposal + +--- + +> **Disclaimer:** This RFC and the accompanying CLI implementation (`dannystocker/openwebui-cli`) are not affiliated with or endorsed by the OpenWebUI project. This is a community proposal demonstrating what an official CLI could look like, with the hope that the OpenWebUI team might find it useful. +> +> If the OpenWebUI team isn't interested in official adoption, that's completely fine - this will remain a community tool for anyone who finds it helpful. --- ## Executive Summary -We propose building an **official CLI for OpenWebUI** to complement the web interface. This CLI would enable developers, DevOps engineers, and power users to interact with OpenWebUI programmatically from the command line, enabling automation, scripting, and integration into CI/CD pipelines. +We'd like to propose building an **official CLI for OpenWebUI** to complement the web interface. This CLI would enable developers, DevOps engineers, and power users to interact with OpenWebUI programmatically from the command line, enabling automation, scripting, and integration into CI/CD pipelines. **Why Now:** - No official CLI exists (only `open-webui serve` to start server)