Installation
NeuraFrame Studio™ ships as a single archive per architecture. Installation is one command and takes about a minute.
System requirements
| Item | Requirement |
|---|---|
| Operating system | Linux, ARM64 or x86_64 (Ubuntu 22.04+ / Debian 12+ recommended) |
| Privileges | root (the installer uses sudo) |
| Init system | systemd |
| Model | a model endpoint reachable over HTTP: a local model, or a hosted provider (OpenAI, Anthropic, Grok, or compatible) through the gateway |
| Disk | about 15 GB free for a local model; far less when fronting a remote provider through the gateway |
| Network | internet for online trial and license activation (offline available by request) |
| Hardware | No special hardware required. NeuraFrame™ runs on standard ARM64 or x86_64 Linux, from a Jetson Orin at the edge to a laptop, a cloud instance (for example AWS EC2), or a multi-GPU server. A GPU accelerates your model, not NeuraFrame™ itself. |
| Scale | single device or a fleet; the same package runs on one machine or hundreds |
The installer runs a read-only preflight first and stops with a clear reason if the system does not meet the floors, so it never leaves a half-installed state.
Choose your package
Two builds are provided. Pick the one that matches your CPU:
- ARM64 for Jetson Orin, ARM64 edge devices, robotics platforms, and supported ARM64 Linux.
- x86_64 for Linux workstations, servers, local LLM hosts, and development machines.
Not sure? Run uname -m: aarch64 means the ARM64 package, x86_64 means the x86_64 package.
Install
# ARM64 example
tar -xzf neuraframe-studio-arm64.tar.gz
cd neuraframe-studio
sudo bash install.sh
The installer deploys to /opt/neuraframe-studio, writes configuration to /etc/neuraframe-studio, installs the neuraframe command on your PATH, and registers and starts a background service. It is quiet by default; add --verbose to see each step.
Verify
neuraframe status neuraframe doctor
status shows the service health and license state. doctor runs the preflight plus a service and license summary in one shot, so if anything is off it is easy to spot.
Choose your install mode
During install you choose how NeuraFrame™ integrates. You can change it later in the config.
| Mode | Best for | What changes in your app |
|---|---|---|
| Proxy (drop-in) | Existing apps and larger deployments that just want the savings | One line: point your base URL at NeuraFrame™ instead of the model. Nothing else. |
| Native API | Teams that want explicit control and teaching | Call NeuraFrame™'s ask and correct API directly. |
Most teams start with proxy mode because it is invisible: same requests, same responses, you just get fewer model calls. See the Gateway for how it works. Both modes can run at once.
Connect your model
NeuraFrame™ talks to your local model over HTTP. Point it at your completion and embedding endpoints in /etc/neuraframe-studio/config.json (or with neuraframe config set), then restart the service. See Using NeuraFrame™.
Updating to a new version
To update, install the newer package the same way you installed the first. There is no separate upgrade step and nothing to migrate by hand.
tar -xzf neuraframe-studio-*.tar.gz cd neuraframe-studio-* sudo bash install.sh # installs over the existing version neuraframe status # confirm the new version is running
Your learned memory, license, and configuration are preserved. They live outside the program files (reuse memory in /var/lib/neuraframe-studio, config and license in /etc/neuraframe-studio), and the reuse memory store is schema-versioned, so a newer build opens the existing store and migrates it in place instead of wiping it. You do not re-activate and you do not lose what NeuraFrame™ has learned. Only neuraframe uninstall --purge removes that state.
Uninstall
Removal is clean and leaves nothing behind.
neuraframe uninstall # keeps config, license, and reuse memory neuraframe uninstall --purge # removes everything, nothing left behind
neuraframe uninstall prompts before removing and keeps your config, license, and reuse memory so a reinstall resumes. Add --purge to wipe everything and leave nothing behind.