NativeLab AI framework
Project description
NativeLab
A fully local, privacy-first LLM workbench powered by llama.cpp - desktop GUI, terminal CLI, and an experimentation layer.
NativeLab is a desktop and terminal client for running large language models entirely on your machine. No API keys, no cloud, no data leaving your computer. It wraps llama.cpp behind a polished PyQt6 GUI and a Claude-Code-style terminal CLI, with first-class support for multi-model pipelines, document references, long-document summarization, and a brand-new Labs experimentation layer.
pip install nativelab
nativelab # GUI
nativelab --cli # terminal client (interactive setup → chat)
✨ Highlights
- 🖥️ Desktop GUI - Chat, model library, visual pipeline builder, MCP, HuggingFace downloader, Labs, theming.
- ⌨️ Terminal CLI -
nativelab --cliopens an interactive setup wizard, downloads a model, and drops you straight into a chat REPL with@fileembedding, slash commands, and built-in linting. - 🧪 Labs - A dedicated experimentation layer with a shared endpoint API. New lab features get engine status, model swap, context change, and LLM calls for free.
- 🔌 Integrations - Local JSON endpoint, route browser, and saved Discord/WhatsApp bot connector profiles.
- 🔗 Visual Pipeline Builder - 20 node types (model, transform, branch, loop, custom Python), live execution log, save/load.
- 🌐 API + local mixing - OpenAI-compatible and Anthropic endpoints work side-by-side with local GGUFs.
- ⚡ Parallel + pipeline mode - Run reasoning + coding engines simultaneously and chain them automatically.
- 🧠 Auto family detection - 20+ model families recognised from filename; correct prompt template applied.
- 📦 HuggingFace downloader - Search any GGUF repo and pull files without leaving the app.
See docs/features.md for the full v0.3.0 changelog and docs/architecture.md for the layered design.
📚 Documentation
The docs are split into short, focused files so you can jump straight to what you need.
| Page | What's inside |
|---|---|
| docs/README.md | Documentation index with one-line summaries. |
| docs/installation.md | Install, llama.cpp setup, first-time workspace. |
| docs/cli.md | nativelab --cli - quick reference + link to the beginner guide. |
| docs/features.md | What's new in v0.3.0 + the full feature catalogue. |
| docs/architecture.md | Layered architecture, project structure, data flow. |
| docs/labs.md | The Labs experimentation layer + how to add a feature. |
| docs/integrations.md | Integration endpoint routes, local HTTP bridge, Discord and WhatsApp bot connectors. |
| docs/models.md | Model registry, families, quantization, API models. |
| docs/workflows.md | Pipelines, references, summarization, MCP, HF downloads. |
| docs/ui.md | GUI tour, theming, shortcuts, data persistence. |
| docs/troubleshooting.md | Common errors and their fixes. |
Beginner-friendly walkthroughs:
- 🆕 Never used a terminal LLM tool? Start with nativelab/cli/cli_guide.md.
- 🆕 Want to add a lab feature? Read docs/labs.md.
⚡ Quick start
GUI
pip install nativelab
nativelab
The first launch opens the desktop app. Use the Download tab to install llama.cpp binaries and grab a GGUF model - no manual setup required.
CLI
pip install nativelab
nativelab --cli
The CLI runs an interactive wizard the first time:
- Verifies
llama-server/llama-cliare present (or guides you to install them). - Lets you pick or download a GGUF model from HuggingFace.
- Asks for a context size with sensible defaults.
- Drops you into a chat REPL with
@fileembedding and slash commands.
you ▸ explain what @nativelab/labs/endpoints.py does
bot ▸ It's the shared surface every Labs panel uses to talk to engines…
you ▸ /lint nativelab/cli/chat.py
✓ [pyflakes] nativelab/cli/chat.py - clean
you ▸ /quit
Full beginner walkthrough: nativelab/cli/cli_guide.md.
🧪 Labs - the experimentation layer
The nativelab/labs/ package is a sandbox for new features. Every lab panel receives a single LabEndpoints instance and uses it for all engine interaction:
from nativelab.labs import LabEndpoints
# Read state
endpoints.status_text # "🟢 Server :8612"
endpoints.model_path # "/abs/path/to/mistral-7b.Q4_K_M.gguf"
endpoints.snapshot() # {model_name, ctx_value, server_port, …}
# Synchronous LLM call - auto-routes API > server > CLI
endpoints.call_llm(messages=[...], system_prompt="…")
# Reverse routing - ask the host app to change state
endpoints.request_load_model("/path/to/other.gguf")
endpoints.request_context(8192)
endpoints.request_unload()
Add a lab feature by dropping nativelab/labs/<feature>.py with a QWidget panel that has LAB_NAME, LAB_ICON, and a set_endpoints(...) method, then appending it to LAB_FEATURES. Full guide in docs/labs.md.
🛠️ Requirements
- Python 3.10+
- PyQt6 (installed automatically as a dependency)
- llama.cpp binaries -
llama-server/llama-cli. The GUI's Download tab installs these for you, or you can drop them in./llama/bin/. - Optional:
psutil(RAM monitor),PyPDF2(PDF summarization),pyflakes/flake8/pylint(CLI lint).
Detailed instructions in docs/installation.md.
🤝 Contributing
Issues and PRs welcome. See CONTRIBUTING.md and CODE_OF_CONDUCT.md.
For security disclosures, see SECURITY.md.
📜 License
AGPL v3 - see LICENSE. NativeLab depends on llama.cpp (MIT) and PyQt6 (GPL/commercial).
Built for people who want their LLMs local, fast, and under their own control.
Install from PyPI · GitHub · Docs · Issues
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nativelab-0.3.0.tar.gz.
File metadata
- Download URL: nativelab-0.3.0.tar.gz
- Upload date:
- Size: 437.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c2200c85dc4956746438652b703cda3af5a0840a12d4c86b3a8afdcac427f917
|
|
| MD5 |
902ec8f111bd3e5a4722cfc67965f4b2
|
|
| BLAKE2b-256 |
f9541de16f6c010d9326f6781f3b967a5cf7c777aa96f0b0ed7bdb4ab7e30543
|
File details
Details for the file nativelab-0.3.0-py3-none-any.whl.
File metadata
- Download URL: nativelab-0.3.0-py3-none-any.whl
- Upload date:
- Size: 498.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a55afbd9eb27b561b6a63bbebcedee03273a14e85f4a5f819682fb94adb56e6
|
|
| MD5 |
593927cb2eb41a7888cae7e916397cb4
|
|
| BLAKE2b-256 |
0a3ff688d270891218bfa35f35e0fd563f57f0e165b9f1f78f9485f559951532
|