owui-cli 0.1.0__tar.gz → 0.3.0__tar.gz

owui_cli-0.3.0/.github/workflows/publish.yml

@@ -0,0 +1,16 @@
+name: Publish to PyPI
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: uv build
+      - run: uv publish --trusted-publishing always

{owui_cli-0.1.0 → owui_cli-0.3.0}/.gitignore

@@ -1,4 +1,3 @@
-HANDOFF.md
 __pycache__/
 *.pyc
 dist/

{owui_cli-0.1.0 → owui_cli-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owui-cli
-Version: 0.1.0
+Version: 0.3.0
 Summary: Admin CLI for Open WebUI instances
 Project-URL: Homepage, https://github.com/rndmcnlly/owui-cli
 Project-URL: Repository, https://github.com/rndmcnlly/owui-cli
@@ -30,9 +30,13 @@ uvx owui-cli models show gpt-4o
 uvx owui-cli schema knowledge
 ```
 
-## Status
+## Install
 
-Under construction. Coming soon to PyPI.
+```bash
+uvx owui-cli help            # run without installing
+uv tool install owui-cli     # or install globally
+pip install owui-cli          # or via pip
+```
 
 ## Auth
 

{owui_cli-0.1.0 → owui_cli-0.3.0}/README.md

@@ -11,9 +11,13 @@ uvx owui-cli models show gpt-4o
 uvx owui-cli schema knowledge
 ```
 
-## Status
+## Install
 
-Under construction. Coming soon to PyPI.
+```bash
+uvx owui-cli help            # run without installing
+uv tool install owui-cli     # or install globally
+pip install owui-cli          # or via pip
+```
 
 ## Auth
 

{owui_cli-0.1.0 → owui_cli-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "owui-cli"
-version = "0.1.0"
+version = "0.3.0"
 description = "Admin CLI for Open WebUI instances"
 readme = "README.md"
 license = "MIT"

owui_cli-0.3.0/src/owui_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.0"

{owui_cli-0.1.0 → owui_cli-0.3.0}/src/owui_cli/cli.py

@@ -10,6 +10,7 @@ Commands:
 Use --json for machine-readable output on any command.
 """
 
+import base64
 import json
 import os
 import re
@@ -131,6 +132,34 @@ def _parse_frontmatter(raw: str) -> tuple[dict[str, str], str]:
     return meta, raw[fm.end():]
 
 
+def _write_file(path: str, content: str | bytes):
+    """Write content to a file, creating parent directories as needed."""
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    mode = "wb" if isinstance(content, bytes) else "w"
+    with open(path, mode) as f:
+        f.write(content)
+
+
+def _write_json(path: str, obj):
+    """Write JSON to a file, creating parent directories as needed."""
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    with open(path, "w") as f:
+        json.dump(obj, f, indent=2, ensure_ascii=False)
+        f.write("\n")
+
+
+def _extract_data_uri(data_uri: str) -> tuple[str, bytes] | None:
+    """Decode a data:image/*;base64,... URI. Returns (ext, bytes) or None."""
+    if not data_uri or not data_uri.startswith("data:image/"):
+        return None
+    header, _, b64data = data_uri.partition(",")
+    if not b64data:
+        return None
+    mime = header.split(";")[0].replace("data:", "")
+    ext = mime.split("/")[1] if "/" in mime else "png"
+    return ext, base64.b64decode(b64data)
+
+
 def _slugify(title: str) -> str:
     return re.sub(r"[^a-z0-9]+", title.lower(), "").strip("_") if not title else re.sub(r"[^a-z0-9]+", "_", title.lower()).strip("_")
 
@@ -162,6 +191,7 @@ class Resource:
         self._commands["show"] = (self.cmd_show, "<id>", (1, 1))
         self._commands["deploy"] = (self.cmd_deploy, f"<source{self.deploy_ext}> [id]", (1, 2))
         self._commands["pull"] = (self.cmd_pull, "<id>", (1, 1))
+        self._commands["pull-all"] = (self.cmd_pull_all, "[dir]", (0, 1))
         self._commands["delete"] = (self.cmd_delete, "<id>", (1, 1))
 
     def add_command(self, name, fn, arg_spec, arg_range):
@@ -281,6 +311,36 @@ class Resource:
         if content and not content.endswith("\n"):
             sys.stdout.write("\n")
 
+    def cmd_pull_all(self, url: str, token: str, out_dir: str = "."):
+        """Pull all items into <out_dir>/<id>/source + <out_dir>/<id>/meta.json."""
+        src_name = {"tools": "tool.py", "functions": "function.py", "skills": "skill.md"}.get(self.name, "source")
+        with httpx.Client(timeout=TIMEOUT) as c:
+            data = _get(c, url, f"{self.prefix}/", token).json()
+        items = data if isinstance(data, list) else data.get("items", data.get("data", []))
+        ids = sorted(item.get("id", "") for item in items)
+        if not ids:
+            out("(none)")
+            return
+        count = 0
+        with httpx.Client(timeout=TIMEOUT) as c:
+            for item_id in ids:
+                r = c.get(_api(url, self.item_path(item_id)), headers=_headers(token))
+                if r.status_code == 404:
+                    print(f"  skip {item_id} (not found)", file=sys.stderr)
+                    continue
+                r.raise_for_status()
+                item = r.json()
+                item_dir = os.path.join(out_dir, item_id)
+                # Write source
+                content = item.pop(self.content_key, "")
+                _write_file(os.path.join(item_dir, src_name), content if content.endswith("\n") else content + "\n")
+                # Write metadata (everything except source content)
+                _write_json(os.path.join(item_dir, "meta.json"), item)
+                count += 1
+                if not JSON_OUTPUT:
+                    print(f"  {item_id}")
+        out(f"pulled {count} {self.name}")
+
     def cmd_delete(self, url: str, token: str, item_id: str):
         with httpx.Client(timeout=TIMEOUT) as c:
             r = c.get(_api(url, self.item_path(item_id)), headers=_headers(token))
@@ -356,6 +416,36 @@ class SkillsResource(Resource):
         if content and not content.endswith("\n"):
             sys.stdout.write("\n")
 
+    def cmd_pull_all(self, url: str, token: str, out_dir: str = "."):
+        """Pull all skills into <out_dir>/<id>/skill.md (with frontmatter) + meta.json."""
+        with httpx.Client(timeout=TIMEOUT) as c:
+            data = _get(c, url, f"{self.prefix}/", token).json()
+        items = data if isinstance(data, list) else data.get("items", data.get("data", []))
+        ids = sorted(item.get("id", "") for item in items)
+        if not ids:
+            out("(none)")
+            return
+        count = 0
+        with httpx.Client(timeout=TIMEOUT) as c:
+            for item_id in ids:
+                r = c.get(_api(url, self.item_path(item_id)), headers=_headers(token))
+                if r.status_code == 404:
+                    print(f"  skip {item_id} (not found)", file=sys.stderr)
+                    continue
+                r.raise_for_status()
+                item = r.json()
+                item_dir = os.path.join(out_dir, item_id)
+                # Write skill.md with frontmatter
+                content = item.pop("content", "")
+                fm = f"---\nid: {item_id}\nname: {item.get('name','')}\ndescription: {item.get('description','')}\n---\n"
+                _write_file(os.path.join(item_dir, "skill.md"), fm + content + ("" if content.endswith("\n") else "\n"))
+                # Write metadata
+                _write_json(os.path.join(item_dir, "meta.json"), item)
+                count += 1
+                if not JSON_OUTPUT:
+                    print(f"  {item_id}")
+        out(f"pulled {count} skills")
+
     def cmd_toggle(self, url: str, token: str, skill_id: str):
         with httpx.Client(timeout=TIMEOUT) as c:
             r = _post(c, url, f"{self.item_path(skill_id)}/toggle", token)
@@ -415,6 +505,7 @@ def models_show(url, token, model_id):
              ("base", info.get("base_model_id","(none)")),
              ("active", str(info.get("is_active","?"))),
              ("tools", ", ".join(meta.get("toolIds") or []) or "(none)"),
+             ("filters", ", ".join(params.get("filter_ids") or []) or "(none)"),
              ("knowledge", ", ".join(k.get("name","?") for k in (meta.get("knowledge") or [])) or "(none)"),
              ("system", f"{len(params.get('system',''))} chars"),
              ("grants", str(len(info.get("access_grants") or [])))]
@@ -440,6 +531,85 @@ def models_delete(url, token, model_id):
         _post(c, url, "/api/v1/models/model/delete", token, {"id": model_id})
     out(f"deleted {model_id}")
 
+def _models_fetch(c, url, token, model_id):
+    """Fetch a model by ID, returning the parsed JSON."""
+    r = _get(c, url, f"/api/v1/models/model?id={model_id}", token)
+    return r.json()
+
+def models_set_tools(url, token, model_id, *tool_ids):
+    """Set the tool bindings for a workspace model (pass no IDs to clear)."""
+    with httpx.Client(timeout=TIMEOUT) as c:
+        model = _models_fetch(c, url, token, model_id)
+        info = model.get("info") or {}
+        meta = info.setdefault("meta", {})
+        params = info.setdefault("params", {})
+        ids = list(tool_ids)
+        meta["toolIds"] = ids
+        # keep params.tool_ids in sync (used by some OWUI versions)
+        params["tool_ids"] = ids
+        model["info"] = info
+        r = _post(c, url, "/api/v1/models/model/update", token, model)
+    label = ", ".join(ids) if ids else "(none)"
+    out(f"tools for {model_id}: {label}")
+
+def models_set_filters(url, token, model_id, *filter_ids):
+    """Set the filter bindings for a workspace model (pass no IDs to clear)."""
+    with httpx.Client(timeout=TIMEOUT) as c:
+        model = _models_fetch(c, url, token, model_id)
+        info = model.get("info") or {}
+        params = info.setdefault("params", {})
+        ids = list(filter_ids)
+        params["filter_ids"] = ids
+        model["info"] = info
+        r = _post(c, url, "/api/v1/models/model/update", token, model)
+    label = ", ".join(ids) if ids else "(none)"
+    out(f"filters for {model_id}: {label}")
+
+
+def models_pull_all(url, token, out_dir="."):
+    """Pull all workspace models into <out_dir>/<id>/model.json, extracting profile images."""
+    with httpx.Client(timeout=TIMEOUT) as c:
+        data = _get(c, url, "/api/v1/models", token).json().get("data", [])
+
+    # Filter to workspace models: those with a base_model_id in their info
+    # (raw connection proxies have no info or no base_model_id)
+    workspace = []
+    for m in data:
+        info = m.get("info") or {}
+        base = info.get("base_model_id", "")
+        if base:
+            workspace.append(m)
+
+    if not workspace:
+        out("(no workspace models)")
+        return
+
+    count = 0
+    with httpx.Client(timeout=TIMEOUT) as c:
+        for m in sorted(workspace, key=lambda m: m.get("id", "")):
+            model_id = m.get("id", "")
+            # Fetch full model data
+            r = _get(c, url, f"/api/v1/models/model?id={model_id}", token)
+            model = r.json()
+            model_dir = os.path.join(out_dir, model_id)
+
+            # Extract profile image from data URI (top-level meta, not info.meta)
+            top_meta = model.get("meta") or {}
+            img_url = top_meta.get("profile_image_url", "")
+            extracted = _extract_data_uri(img_url)
+            if extracted:
+                ext, img_bytes = extracted
+                _write_file(os.path.join(model_dir, f"profile.{ext}"), img_bytes)
+                top_meta["profile_image_url"] = f"profile.{ext}"
+
+            _write_json(os.path.join(model_dir, "model.json"), model)
+            count += 1
+            if not JSON_OUTPUT:
+                img_note = f" +profile.{ext}" if extracted else ""
+                print(f"  {model_id}{img_note}")
+
+    out(f"pulled {count} models")
+
 
 # ── knowledge (special: files subresource, file/remove is destructive) ─
 
@@ -872,6 +1042,9 @@ COMMANDS.update({
     ("models",    "create"):      (models_create,        "<model.json>",        (1, 1)),
     ("models",    "update"):      (models_update,        "<model.json>",        (1, 1)),
     ("models",    "delete"):      (models_delete,        "<id>",                (1, 1)),
+    ("models",    "set-tools"):   (models_set_tools,     "<id> [tool-id]...",   (1, 999)),
+    ("models",    "set-filters"): (models_set_filters,   "<id> [filter-id]...", (1, 999)),
+    ("models",    "pull-all"):    (models_pull_all,      "[dir]",               (0, 1)),
     ("knowledge", "list"):        (knowledge_list,       "",                    (0, 0)),
     ("knowledge", "show"):        (knowledge_show,       "<id>",                (1, 1)),
     ("knowledge", "files"):       (knowledge_files,      "<id>",                (1, 1)),

owui_cli-0.3.0/update-schema.py

@@ -0,0 +1,121 @@
+# /// script
+# requires-python = ">=3.11"
+# dependencies = ["httpx"]
+# ///
+"""Fetch Open WebUI router sources and emit an LLM prompt to regenerate api-schema.json.
+
+Usage:
+    uv run --script update-schema.py [tag-or-branch]
+
+Default branch: main. Pass a tag like "v0.8.12" to pin to a release.
+
+This fetches all backend router files from GitHub, then prints a self-contained
+prompt to stdout. Pipe it to an LLM (or paste into a session) to produce the
+updated api-schema.json.
+
+Example workflow:
+    uv run --script update-schema.py v0.9.0 > /tmp/schema-prompt.txt
+    # Feed /tmp/schema-prompt.txt to your preferred LLM
+    # Save the JSON output to src/owui_cli/data/api-schema.json
+    # Update _meta.source and _meta.extracted fields
+"""
+
+import sys
+import httpx
+
+ROUTERS = [
+    "configs", "groups", "chats", "prompts", "users", "auths",
+    "models", "tools", "functions", "knowledge", "files", "skills",
+    "memories", "channels", "folders", "notes", "evaluations",
+]
+
+BASE_URL = "https://raw.githubusercontent.com/open-webui/open-webui"
+ROUTER_PATH = "backend/open_webui/routers"
+
+SCHEMA_FORMAT = """\
+{
+  "_meta": {
+    "source": "open-webui/open-webui <REF>",
+    "extracted": "<DATE>",
+    "auth_levels": {"A": "admin", "V": "verified user", "C": "any authenticated", "N": "no auth"},
+    "format": "[METHOD, path, auth, body_or_null, description]"
+  },
+  "<resource>": {
+    "prefix": "/api/v1/<resource>",
+    "note": "optional note about quirks",
+    "endpoints": [
+      ["GET", "/", "V", null, "List items"],
+      ["POST", "/create", "A", "{name,description?}", "Create item"],
+      ...
+    ]
+  },
+  ...
+}"""
+
+
+def fetch_routers(ref: str) -> dict[str, str]:
+    """Fetch all router source files. Returns {name: source_code}."""
+    sources = {}
+    with httpx.Client(timeout=30.0, follow_redirects=True) as client:
+        for name in ROUTERS:
+            url = f"{BASE_URL}/{ref}/{ROUTER_PATH}/{name}.py"
+            print(f"  fetching {name}.py ...", file=sys.stderr)
+            r = client.get(url)
+            if r.status_code == 404:
+                print(f"  WARNING: {name}.py not found at {ref}", file=sys.stderr)
+                continue
+            r.raise_for_status()
+            sources[name] = r.text
+    return sources
+
+
+def emit_prompt(ref: str, sources: dict[str, str]):
+    """Print the LLM prompt to stdout."""
+    print(f"""\
+I need you to produce a JSON file called api-schema.json by reading the Open WebUI
+router source files below. This schema is used by a CLI tool for agent-driven API
+introspection.
+
+## Output format
+
+Emit ONLY valid JSON matching this structure (no markdown fences, no commentary):
+
+{SCHEMA_FORMAT}
+
+## Rules
+
+1. Every @router.get, @router.post, @router.delete, @router.put, @router.patch
+   decorator becomes one entry in the endpoints array.
+2. Path is relative to the router prefix (e.g. "/" not "/api/v1/tools/").
+3. Auth level is determined by the dependency:
+   - get_admin_user -> "A"
+   - get_verified_user -> "V"
+   - get_current_user -> "C"
+   - no auth dependency -> "N"
+4. Body description is a compact string like "{{name,description?}}" showing the
+   Pydantic model fields. Use ? for Optional fields. null if no request body.
+5. Include a "note" field on resources with path quirks (e.g. /id/{{id}} vs /{{id}},
+   query params instead of path params, destructive operations).
+6. Set _meta.source to "open-webui/open-webui {ref}"
+7. Be exhaustive. Every endpoint. No omissions.
+
+## Router source files ({len(sources)} files from {ref})
+""")
+
+    for name, source in sources.items():
+        print(f"### {name}.py\n")
+        print(f"```python\n{source}\n```\n")
+
+
+def main():
+    ref = sys.argv[1] if len(sys.argv) > 1 else "main"
+    print(f"Fetching routers from {ref} ...", file=sys.stderr)
+    sources = fetch_routers(ref)
+    print(f"Fetched {len(sources)} router files.", file=sys.stderr)
+    emit_prompt(ref, sources)
+    print(f"\nPrompt written to stdout ({sum(len(s) for s in sources.values())} chars of source).", file=sys.stderr)
+    print(f"Feed this to an LLM and save the JSON output to src/owui_cli/data/api-schema.json", file=sys.stderr)
+
+
+if __name__ == "__main__":
+    main()

owui_cli-0.1.0/src/owui_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.0"