CLI reference

The public command is neuraframe. nfctl is kept as an alias, so anywhere you see neuraframe you can type nfctl instead.

Overview

neuraframe status            # service health and license state
neuraframe trial start       # start the 7-day trial
neuraframe activate          # activate a paid license
neuraframe license           # show device fingerprint and license validity
neuraframe license refresh   # pull a renewed license
neuraframe billing           # open the billing portal
neuraframe stats             # reuse counters
neuraframe ask "..."         # round trip through the engine
neuraframe correct "..." "..." # teach a correction
neuraframe config get|set    # read or set safe config knobs
neuraframe logs              # recent service logs
neuraframe doctor            # preflight plus service and license summary
neuraframe demo              # run the bundled example
neuraframe uninstall         # remove the product

status

Prints service state, version, whether the engine is active or in pass-through, and license validity. Use this first when something looks off.

trial start

Starts the 7-day free trial for this device. Reads the device fingerprint, asks for your email, and installs a signed trial license.

activate

Activates a paid license for this device using the email tied to your subscription.

license / license refresh

license shows this device's fingerprint and whether the installed license is valid and how long remains. license refresh pulls a renewed signed license from the configured endpoint; connected devices also refresh automatically before expiry.

billing

Opens the billing portal where you can update payment methods, view invoices, cancel, or renew.

stats

Shows reuse counters: total requests, model calls made, calls avoided, and memory used.

ask

neuraframe ask "<question>" [doc_id]

Sends a question through the engine. The result reports its source, so you can see whether it was answered by the model or served from memory. An optional document id scopes the question to an ingested document.

correct

neuraframe correct "<original claim>" "<corrected claim>"

Teaches a correction so future matching answers use the corrected result.

config get | set

neuraframe config get
neuraframe config set completion_url http://127.0.0.1:8080/completion

Reads or updates safe configuration knobs (host, port, completion and embedding endpoints). Restart the service to apply changes.

logs

Shows recent service logs (via journalctl when available), useful for diagnosing startup or model-connection issues.

doctor

Runs the compatibility preflight, then a service and license summary, in one command. A borrowed convention (like brew doctor): it diagnoses whether everything is set up correctly.

demo

Runs the bundled example workflow to confirm reuse works on a fresh install. Requires a local model running and connected first (set the completion and embedding endpoints, see Using NeuraFrame™), since the example calls your model. NeuraFrame™ does not include a model.

uninstall

neuraframe uninstall           # keeps config, license, and memory
neuraframe uninstall --purge   # removes everything
neuraframe uninstall --yes     # skip the confirmation prompt

Removes NeuraFrame™. Without --purge it keeps your config, license, and reuse memory so a reinstall resumes; with --purge it removes everything and leaves nothing behind.

Fleet admin (nf-fleet)

The Fleet server ships its own admin command, nf-fleet. It is installed on the Fleet server host, not on devices, and operates the local fleet database directly, so it needs no tokens or signing. Run it as the user that owns the fleet data (or with sudo).

nf-fleet provision             # print the fleet identity to bake into your device package
nf-fleet status                # queue, approved, and device counts
nf-fleet review                # list learnings awaiting approval, with IDs
nf-fleet approve --all         # approve everything pending
nf-fleet approve ID [ID ...]   # approve specific learnings by ID
nf-fleet reject ID [ID ...]    # reject specific learnings by ID
nf-fleet policy                # show the current sync policy
nf-fleet policy set KEY VALUE  # set a policy value (example: nf-fleet policy set cadence daily)

Point it at a non-default data directory with --root (or the NF_FLEET_ROOT environment variable). If you set a vault passphrase, export NF_FLEET_PASSPHRASE in the same shell so it can read encrypted submissions. Full round-trip operation, including how devices join and sync, is on the Studio Fleet and Embodied Fleet pages.