Skip to content

Latest commit

 

History

History
73 lines (59 loc) · 3.82 KB

reference.mdx

File metadata and controls

73 lines (59 loc) · 3.82 KB
title Reference
description CLI, inference APIs, configuration, and local files
icon book-open

Magnitude normally configures and manages these interfaces automatically. This reference is for agents, automation, advanced integrations, and manual recovery.

CLI

Command Purpose
magnitude setup Open interactive model browsing and setup
magnitude service install Install and enable the per-user service without starting it
magnitude service start Install or refresh, start, and await the user service
magnitude service status Show installation, startup, runtime, and active-model status
magnitude service stop Stop the service without uninstalling it
magnitude service uninstall Stop and remove the service definition while preserving user data
magnitude catalog list Show catalog, assessment, acquisition, and residency state
magnitude catalog pull <model-id> Install or update a catalog model
magnitude catalog remove <model-id> Remove an installed catalog model
magnitude catalog cancel <model-id> Cancel active acquisition work
magnitude models status Show installed models and their residency state
magnitude models load <model-id> Load a model by canonical model ID
magnitude models stop Stop the active local model
magnitude connections list Show supported and installed harnesses
magnitude connections add <harness> [--set-model <model-id>] [--install-skill] Connect installed models and optionally select a model and refresh the harness skill
magnitude connections sync [harness] Refresh connected harness configuration
magnitude connections remove <harness> Remove a harness connection
magnitude docs [topic-id] List or read bundled documentation for agents
magnitude docs onboarding Read the complete agent-guided setup workflow
magnitude update Update Magnitude

Run magnitude --help or append --help to a command for its complete options. Every non-interactive observation command supports --json; agents should begin with magnitude docs onboarding for the complete CLI-only setup and model-selection workflow.

Inference APIs

The background service listens on loopback at http://127.0.0.1:10100.

API Base URL
OpenAI-compatible http://127.0.0.1:10100/inference/v1
Anthropic-compatible http://127.0.0.1:10100/inference/anthropic

The OpenAI-compatible API supports model listing, Chat Completions, and Responses. The Anthropic-compatible API supports Messages and token counting. Harness setup configures the correct interface automatically.

Environment variables

Variable Purpose
EXA_API_KEY Enable web search in Magnitude Harness
HF_HUB_CACHE Set the Hugging Face Hub cache directory
HUGGINGFACE_HUB_CACHE Legacy Hugging Face Hub cache override
HF_HOME Set the Hugging Face data directory
XDG_CACHE_HOME Set the base cache directory

Hugging Face cache settings are checked in the order shown. If none is set, Magnitude checks ~/.cache/huggingface/hub.

Files and directories

Path Purpose
~/.magnitude/models/ Magnitude-managed local models
~/.magnitude/cache/ Model metadata, hardware profiles, and disposable caches
~/.magnitude/sessions/ Magnitude Harness conversations and session logs
~/.magnitude/logs/ CLI logs and macOS service logs
~/.magnitude/traces/ Local trace data when tracing is enabled
~/.magnitude/config.json User settings and model selections
~/.magnitude/harness-connections.json Managed harness connections

Deleting ~/.magnitude/cache causes derived data to be rebuilt but does not delete downloaded models. Do not delete the complete ~/.magnitude directory as a general troubleshooting step.