Skip to main content

Top-Level Commands

serve

Load a local model and expose it at localhost:6767/v1. Auto-detects LlamaCPP or MLX.
See the serve command documentation for detailed usage.

launch

Start a local model, then launch an AI agent with it pre-wired (environment variables set automatically).
See the launch command documentation for detailed usage.

threads

List and inspect conversation threads saved by the Jan app.

Subcommands

Print all threads as JSON.
Output: JSON array of thread objects with metadata.
Print a single thread’s metadata as JSON.
string
required
Thread ID to retrieve
Output: JSON object with thread metadata.
Permanently delete a thread and all its messages.
string
required
Thread ID to delete
Output: Confirmation JSON with deleted thread ID.
Print all messages in a thread as JSON.
string
required
Thread ID to get messages from
Output: JSON array of message objects.

models

List and load models installed in the Jan data folder.

Subcommands

Print all installed models as JSON (from the Jan data folder).
string
default:"all"
Filter by engine: llamacpp, mlx, or all
Example Output:
Load a model and serve it — alias for the top-level serve command.
Accepts the same options as jan serve. See serve documentation.
Load an MLX model directly (macOS / Apple Silicon only).
string
required
Model ID as shown by jan models list --engine mlx
string
Path to the MLX model directory (auto-resolved from model.yml when omitted)
string
Path to the mlx-server binary (auto-discovered from Jan.app when omitted)
number
default:"6767"
Port the model server listens on (0 = pick a random free port)
number
default:"0"
Context window size in tokens (0 = model default)
boolean
default:"false"
Treat the model as an embedding model
number
default:"120"
Seconds to wait for the model server to become ready
string
default:""
API key required by clients (sets MLX_API_KEY on the server)

app

Show app configuration and data folder location.

Subcommands

Print the Jan data folder path (where models, threads, and config are stored).
Example Output:
Print the Jan configuration as JSON.
Output: JSON object with Jan configuration settings.

Global Options

flag
Display help information for any command
flag
Display the Jan CLI version
flag
Print full server logs (llama.cpp / mlx output) instead of the loading spinnerAvailable on: serve, launch

Examples


Exit Codes

  • 0: Success
  • 1: Error (with error message printed to stderr)

See Also

Serve Command

Detailed guide for serving models

Launch Command

Wire AI agents to local models