forked from enderofwings/NexusOS
feat: add portable NexusOS CLI and packaging
This commit is contained in:
@@ -5,8 +5,10 @@
|
||||
# NexusOS
|
||||
|
||||
**A local-first AI assistant platform.** Runs entirely on your machine — a
|
||||
Python/FastAPI backend, a bundled Ollama instance for inference, a persistent
|
||||
memory service, and a React frontend. No external AI provider is called.
|
||||
Python/FastAPI backend, an Ollama-compatible endpoint for inference, a
|
||||
persistent memory service, and a React frontend. Ollama is local by default;
|
||||
Termux and container installs can explicitly point at a separately managed
|
||||
endpoint.
|
||||
|
||||
</div>
|
||||
|
||||
@@ -15,10 +17,12 @@ memory service, and a React frontend. No external AI provider is called.
|
||||
## What it is
|
||||
|
||||
NexusOS ("Nexus") is a self-hosted assistant you actually own. All inference
|
||||
runs through a **locally bundled Ollama** on `localhost`; conversations, facts,
|
||||
and settings live in local SQLite. It ships with desktop branding (XFCE theme,
|
||||
runs through **Ollama** on `localhost` by default; conversations, facts, and
|
||||
settings live in local SQLite. It ships with desktop branding (XFCE theme,
|
||||
icons, boot splash) so it can be run as a full assistant environment on Linux,
|
||||
not just a web app.
|
||||
not just a web app. A remote Ollama-compatible URL is an explicit configuration
|
||||
option for lightweight clients; NexusOS never starts or stops that remote
|
||||
process.
|
||||
|
||||
Chat with vision and voice, persistent memory, tool-using playbooks, document
|
||||
RAG scoped to Projects, gated action tools, and full model management — see
|
||||
@@ -88,6 +92,28 @@ NexusOS runs **single-process**: the backend on `:8000` serves the built web UI
|
||||
itself, so there's no separate frontend server at runtime. Ollama is started
|
||||
manually from the app (**Start AI** in the sidebar), not at boot.
|
||||
|
||||
### Python package and portable CLI
|
||||
|
||||
The portable package installs `nexus`, `ncp`, and `nexusos` as equivalent
|
||||
commands. From a checkout today:
|
||||
|
||||
```bash
|
||||
python -m pip install -e ".[standard]"
|
||||
nexus init
|
||||
nexus doctor
|
||||
nexus serve
|
||||
```
|
||||
|
||||
After a package release, the install becomes `python -m pip install
|
||||
"nexusos-ai[standard]"`. The wheel includes the compiled web UI and default
|
||||
playbooks; it keeps writable state outside `site-packages`. See
|
||||
[the CLI reference](docs/CLI.md) for commands, configuration, and dependency
|
||||
profiles.
|
||||
|
||||
Termux uses the base package with a remote Ollama-compatible provider. Its
|
||||
bootstrap and the current Android native-wheel gate are documented in
|
||||
[the Termux guide](docs/TERMUX.md).
|
||||
|
||||
### Linux
|
||||
|
||||
Nexus was built using an Apple T2 computer running Linux Mint XFCE. The desktop
|
||||
|
||||
Reference in New Issue
Block a user