owui-cli 0.2.0__tar.gz → 0.4.0__tar.gz

{owui_cli-0.2.0 → owui_cli-0.4.0}/.gitignore

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

owui_cli-0.4.0/AGENTS.md

@@ -0,0 +1,45 @@
+# AGENTS.md — owui-cli
+
+## Version management
+
+The version number appears in two places and **must be kept in sync**:
+
+- `pyproject.toml` → `version = "X.Y.Z"`
+- `src/owui_cli/__init__.py` → `__version__ = "X.Y.Z"`
+
+Bump both when cutting a release.
+
+## Publishing
+
+Every push to `main` auto-publishes to PyPI via GitHub Actions trusted publishing. Bump the version before pushing, and don't push broken code to main.
+
+## Testing before committing
+
+Always verify changes work against a **production Open WebUI server** before committing. Set `OWUI_URL` and `OWUI_TOKEN` and run the relevant commands to confirm they succeed with real API responses — don't rely on local-only reasoning.
+
+## Architecture
+
+Single-file CLI in `src/owui_cli/cli.py`. The `Resource` base class handles generic CRUD (list, show, deploy, pull, pull-all, delete) for tools, functions, and skills. Special resources (models, knowledge, files, groups, users, chats, configs, prompts) use standalone functions. All commands are registered in the `COMMANDS` dispatch table at the bottom of the file.
+
+## API endpoint patterns
+
+The Open WebUI API is not fully consistent across resources:
+
+- **Tools/functions/skills:** `/api/v1/{resource}/id/{id}`
+- **Models:** `/api/v1/models/model?id={id}`
+- **Knowledge/users:** `/api/v1/{resource}/{id}`
+- **Groups:** `/api/v1/groups/id/{id}`
+
+Always verify the actual endpoint against a running instance when adding new commands.
+
+## Output conventions
+
+All commands support `--json` for machine-readable output. New commands should use the existing output helpers which handle JSON mode automatically:
+
+- `out(data)` — generic output (JSON in `--json` mode, pretty-printed otherwise)
+- `out_table(rows, cols)` — aligned columnar table
+- `out_kv(pairs)` — key-value display
+
+## Schema updates
+
+`update-schema.py` fetches OWUI router sources from GitHub and generates a prompt to feed an LLM. The LLM output goes in `src/owui_cli/data/api-schema.json`. See the script header for the full workflow.

{owui_cli-0.2.0 → owui_cli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owui-cli
-Version: 0.2.0
+Version: 0.4.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

{owui_cli-0.2.0 → owui_cli-0.4.0}/pyproject.toml

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

owui_cli-0.4.0/src/owui_cli/__init__.py

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

{owui_cli-0.2.0 → owui_cli-0.4.0}/src/owui_cli/cli.py

@@ -369,6 +369,83 @@ functions_res = Resource("functions", "/api/v1/functions",
     workspace_path="/workspace/functions")
 
 
+# ── valves (user valves for tools and functions) ─────────────────────
+
+def _valves_get(url, token, kind, item_id):
+    """GET valves for a tool or function. kind is 'tools' or 'functions'."""
+    with httpx.Client(timeout=TIMEOUT) as c:
+        r = _get(c, url, f"/api/v1/{kind}/id/{item_id}/valves/user", token)
+    out(r.json())
+
+def _valves_spec(url, token, kind, item_id):
+    """GET the UserValves spec (schema) for a tool or function."""
+    with httpx.Client(timeout=TIMEOUT) as c:
+        r = _get(c, url, f"/api/v1/{kind}/id/{item_id}/valves/user/spec", token)
+    out(r.json())
+
+def _valves_set(url, token, kind, item_id, json_path):
+    """POST updated user valves from a JSON file."""
+    with open(json_path) as f:
+        payload = json.load(f)
+    with httpx.Client(timeout=TIMEOUT) as c:
+        r = _post(c, url, f"/api/v1/{kind}/id/{item_id}/valves/user/update", token, payload)
+    out(r.json())
+
+def _valves_set_field(url, token, kind, item_id, key, value):
+    """Set a single field in the user valves. Value is parsed as JSON; falls back to string."""
+    try:
+        parsed = json.loads(value)
+    except (json.JSONDecodeError, ValueError):
+        parsed = value
+    with httpx.Client(timeout=TIMEOUT) as c:
+        current = _get(c, url, f"/api/v1/{kind}/id/{item_id}/valves/user", token).json()
+        current[key] = parsed
+        r = _post(c, url, f"/api/v1/{kind}/id/{item_id}/valves/user/update", token, current)
+    out(r.json())
+
+def _valves_unset_field(url, token, kind, item_id, key):
+    """Remove a single field from the user valves."""
+    with httpx.Client(timeout=TIMEOUT) as c:
+        current = _get(c, url, f"/api/v1/{kind}/id/{item_id}/valves/user", token).json()
+        if key not in current:
+            die(f"key '{key}' not found in valves")
+        del current[key]
+        r = _post(c, url, f"/api/v1/{kind}/id/{item_id}/valves/user/update", token, current)
+    out(r.json())
+
+# Wrappers that bind kind='tools'
+def tools_valves_get(url, token, item_id):
+    _valves_get(url, token, "tools", item_id)
+
+def tools_valves_spec(url, token, item_id):
+    _valves_spec(url, token, "tools", item_id)
+
+def tools_valves_set(url, token, item_id, json_path):
+    _valves_set(url, token, "tools", item_id, json_path)
+
+def tools_valves_set_field(url, token, item_id, key, value):
+    _valves_set_field(url, token, "tools", item_id, key, value)
+
+def tools_valves_unset_field(url, token, item_id, key):
+    _valves_unset_field(url, token, "tools", item_id, key)
+
+# Wrappers that bind kind='functions'
+def functions_valves_get(url, token, item_id):
+    _valves_get(url, token, "functions", item_id)
+
+def functions_valves_spec(url, token, item_id):
+    _valves_spec(url, token, "functions", item_id)
+
+def functions_valves_set(url, token, item_id, json_path):
+    _valves_set(url, token, "functions", item_id, json_path)
+
+def functions_valves_set_field(url, token, item_id, key, value):
+    _valves_set_field(url, token, "functions", item_id, key, value)
+
+def functions_valves_unset_field(url, token, item_id, key):
+    _valves_unset_field(url, token, "functions", item_id, key)
+
+
 class SkillsResource(Resource):
     """Skills use frontmatter and have grant/revoke commands."""
 
@@ -505,6 +582,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 [])))]
@@ -530,6 +608,40 @@ 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."""
@@ -1002,11 +1114,23 @@ for res in [tools_res, functions_res, skills_res]:
 
 # Register special resources
 COMMANDS.update({
+    ("tools",     "valves"):      (tools_valves_get,        "<id>",                  (1, 1)),
+    ("tools",     "valves-spec"): (tools_valves_spec,       "<id>",                  (1, 1)),
+    ("tools",     "valves-set"):  (tools_valves_set,        "<id> <valves.json>",    (2, 2)),
+    ("tools",     "valves-set-field"):  (tools_valves_set_field,   "<id> <key> <value>",  (3, 3)),
+    ("tools",     "valves-unset-field"):(tools_valves_unset_field, "<id> <key>",          (2, 2)),
+    ("functions", "valves"):      (functions_valves_get,    "<id>",                  (1, 1)),
+    ("functions", "valves-spec"): (functions_valves_spec,   "<id>",                  (1, 1)),
+    ("functions", "valves-set"):  (functions_valves_set,    "<id> <valves.json>",    (2, 2)),
+    ("functions", "valves-set-field"):  (functions_valves_set_field,   "<id> <key> <value>",  (3, 3)),
+    ("functions", "valves-unset-field"):(functions_valves_unset_field, "<id> <key>",          (2, 2)),
     ("models",    "list"):        (models_list,          "",                    (0, 0)),
     ("models",    "show"):        (models_show,          "<id>",                (1, 1)),
     ("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)),

owui_cli-0.4.0/token-viewer.html

@@ -0,0 +1,103 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>OWUI Token Viewer</title>
+<style>
+* { box-sizing: border-box; margin: 0; padding: 0; }
+body {
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
+  background: #1a1a2e;
+  color: #eee;
+  min-height: 100vh;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  padding: 1rem;
+}
+.card {
+  background: #16213e;
+  border-radius: 12px;
+  padding: 1.5rem;
+  max-width: 480px;
+  width: 100%;
+  box-shadow: 0 8px 32px rgba(0,0,0,.4);
+}
+h1 { font-size: 1.25rem; margin-bottom: .25rem; }
+.sub { color: #888; font-size: .85rem; margin-bottom: 1rem; }
+.token-box {
+  background: #0f0f23;
+  border: 1px solid #333;
+  border-radius: 8px;
+  padding: .75rem;
+  word-break: break-all;
+  font-family: "SF Mono", "Fira Code", monospace;
+  font-size: .8rem;
+  line-height: 1.5;
+  max-height: 40vh;
+  overflow-y: auto;
+  user-select: all;
+  -webkit-user-select: all;
+}
+.token-box.empty { color: #f55; font-family: sans-serif; font-size: .9rem; }
+.btn {
+  display: inline-block;
+  margin-top: .75rem;
+  padding: .6rem 1.2rem;
+  background: #0f3460;
+  color: #eee;
+  border: none;
+  border-radius: 8px;
+  font-size: .9rem;
+  cursor: pointer;
+  -webkit-tap-highlight-color: transparent;
+}
+.btn:active { background: #1a5276; }
+.copied { color: #5f8; font-size: .85rem; margin-left: .5rem; opacity: 0; transition: opacity .2s; }
+.copied.show { opacity: 1; }
+</style>
+</head>
+<body>
+<div class="card">
+  <h1>🔑 OWUI Token</h1>
+  <p class="sub">Reads <code>token</code> from localStorage</p>
+  <div id="token" class="token-box empty">Checking…</div>
+  <button class="btn" id="copy" style="display:none">Copy to clipboard</button>
+  <span class="copied" id="copied">✓ Copied!</span>
+</div>
+<script>
+  const el = document.getElementById('token');
+  const copyBtn = document.getElementById('copy');
+  const copiedMsg = document.getElementById('copied');
+  const raw = localStorage.getItem('token');
+
+  if (raw) {
+    el.textContent = raw;
+    el.classList.remove('empty');
+    copyBtn.style.display = 'inline-block';
+  } else {
+    el.textContent = 'No "token" found in localStorage.\nMake sure you\'re on the same origin as Open WebUI.';
+  }
+
+  copyBtn.addEventListener('click', () => {
+    navigator.clipboard.writeText(raw).then(() => {
+      copiedMsg.classList.add('show');
+      setTimeout(() => copiedMsg.classList.remove('show'), 1500);
+    }).catch(() => {
+      // fallback for older mobile browsers
+      const ta = document.createElement('textarea');
+      ta.value = raw;
+      ta.style.position = 'fixed';
+      ta.style.opacity = 0;
+      document.body.appendChild(ta);
+      ta.select();
+      document.execCommand('copy');
+      document.body.removeChild(ta);
+      copiedMsg.classList.add('show');
+      setTimeout(() => copiedMsg.classList.remove('show'), 1500);
+    });
+  });
+</script>
+</body>
+</html>

owui_cli-0.2.0/src/owui_cli/__init__.py

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