https://github.com/alertua/open_webui_knowledge_sync

https://github.com/alertua/open_webui_knowledge_sync

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/alertua/open_webui_knowledge_sync
• Owner: ALERTua
• Created: 2025-03-26T10:53:38.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-26T11:38:21.000Z (about 1 year ago)
• Last Synced: 2025-03-26T12:29:06.429Z (about 1 year ago)
• Language: Python
• Size: 145 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)

[![Made in Ukraine](https://img.shields.io/badge/made_in-Ukraine-ffd700.svg?labelColor=0057b7)](https://stand-with-ukraine.pp.ua)

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)

[![Russian Warship Go Fuck Yourself](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/RussianWarship.svg)](https://stand-with-ukraine.pp.ua)

Open WebUI Knowledge Sync

-------------------------

A Python CLI tool for synchronizing local files with Open WebUI knowledge bases.

Repository: https://github.com/ALERTua/open_webui_knowledge_sync

## Features

- One-time sync of files and/or directories with Open WebUI knowledge bases

- Real-time file watching and automatic synchronization

- Command-line interface for easy integration

## Requirements

- Open WebUI instance

- [uv](https://docs.astral.sh/uv/getting-started/installation/)

## Installation

```bash

git clone https://github.com/ALERTua/open_webui_knowledge_sync.git

cd open_webui_knowledge_sync

uv sync

```

## Settings

You can save the effort of providing the CLI with the Open WebUI URL and Token for each execution

by creating an `.env` file from [.env.example](.env.example) and filling it with the environment variables.

Or you can just fill those in your system.

## Command-line Tools

This package provides two main command-line tools:

- `owui_sync`: One-time synchronization of files and directories

- `owui_watch`: Continuous monitoring and synchronization of files

For detailed usage instructions, see:

- [Sync Usage](docs/sync-readme.md)

- [Watch Usage](docs/watch-readme.md)

## Caveats

- Do not forget to raise the context length of your prompt!