Skip to content

Command-Line Interface

owui-client is a console script installed with the package for common Open WebUI workflows.

Setup

Connection defaults come from environment variables (see example.env):

export OWUI_SERVER=https://owui.example.com/api
export OWUI_API_KEY=sk-...

Override per-command with --server / --api-key.

Syncing skills

Sync local Markdown skill files (YAML frontmatter with name + description) into Open WebUI's workspace. One-way, idempotent, never deletes.

A skill file:

---
name: code-review
description: Step-by-step instructions for code reviews.
---
Review the diff ...

Sync one file or a whole directory (recursive — handles skill/SKILL.md or skill.md):

owui-client sync-skill  ./skills/code-review/SKILL.md
owui-client sync-skills ./skills

Each file is reported as created, updated, unchanged (no write — the server's updated_at is not bumped), or skipped (not a valid skill). In directory mode, a server error on one file is recorded as failed and does not abort the rest.

See owui_client.shortcuts for the underlying Python API.