Welcome to KToolBox¶
KToolBox downloads public works from Pawchive. The WebUI is the recommended way to use it: common tasks are available as guided forms, and progress remains visible after you leave a page.
New major version
v1 has not yet received enough real-world validation. Some features may still fail. Back up existing settings and downloads before migrating, and report unexpected behavior.
Start with the WebUI¶
- Install the WebUI package.
- Create one directory for your synchronization project.
- Start KToolBox in that directory.
pipx install "ktoolbox[webui]"
mkdir ktoolbox-project
cd ktoolbox-project
ktoolbox webui .
The browser opens automatically. Sign in with the admin username and random password printed in the terminal, add a creator, and create your first task. KToolBox creates ktoolbox.toml when needed and uses downloads as the default output directory.
Choose your next step¶
-
Add creators and download
Follow the project workflows to add creators, search works, create tasks, and adjust filters.
-
Watch a task
Learn about progress, retries, pause, stop, rerun, and cleanup in tasks and live updates.
-
Run on a schedule
Create recurring plans with the automatic synchronization guide.
-
Choose names and folders
Set the default output and readable layout with the naming guide.
Advanced paths¶
You do not need these pages for a normal first run.
| Goal | Guide |
|---|---|
| Keep a stable login or deploy beyond one computer | WebUI deployment reference |
| Automate from a terminal | CLI guide and command reference |
| Inspect every setting | Configuration guide and reference |
| Connect an AI client or Python program | MCP and Python API |
| Upgrade an existing project or fix a problem | Migration guide and FAQ |
Safe defaults¶
The WebUI starts with generated credentials, sensitive-media previews disabled, and a project-local output directory. For local-only access, bind to 127.0.0.1; use HTTPS for untrusted networks. KToolBox never implements Pawchive account or favorites operations.