Skip to content

hints

hints

Rich-formatted error hints for common CLI failure modes.

Functions

hint_no_config 

hint_no_config() -> str

Return a suggestion when no config file is found.

Source code in src/openjarvis/cli/hints.py 
 8
 9
10
11
12
13
14
15
def hint_no_config() -> str:
    """Return a suggestion when no config file is found."""
    return (
        "[yellow]Hint:[/yellow] No config file found.\n"
        "  Run [bold]jarvis init[/bold] to detect hardware and generate "
        "[cyan]~/.openjarvis/config.toml[/cyan].\n"
        "  Or run [bold]jarvis quickstart[/bold] for a guided setup."
    )

hint_no_engine 

hint_no_engine(engine_name: Optional[str] = None) -> str

Return a suggestion when the inference engine is unreachable.

Source code in src/openjarvis/cli/hints.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
def hint_no_engine(engine_name: Optional[str] = None) -> str:
    """Return a suggestion when the inference engine is unreachable."""
    name = engine_name or "ollama"
    return (
        f"[yellow]Hint:[/yellow] Engine '{name}' is not reachable.\n"
        f"  Make sure the {name} server is running.\n"
        "  Run [bold]jarvis doctor[/bold] to check all engines.\n"
        "  Run [bold]jarvis quickstart[/bold] for guided setup.\n"
        "\n"
        "  [dim]To use a remote engine:[/dim]\n"
        f"    [cyan]jarvis config set engine.{name}.host http://<remote-ip>:<port>[/cyan]\n"
        f"    [dim]or[/dim] [cyan]export OLLAMA_HOST=http://<remote-ip>:11434[/cyan]"
    )

hint_no_model 

hint_no_model(model_name: Optional[str] = None) -> str

Return a suggestion when no model is available.

Source code in src/openjarvis/cli/hints.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
def hint_no_model(model_name: Optional[str] = None) -> str:
    """Return a suggestion when no model is available."""
    if model_name:
        return (
            f"[yellow]Hint:[/yellow] Model '{model_name}' not found.\n"
            f"  Try: [bold]ollama pull {model_name}[/bold]\n"
            "  Run [bold]jarvis model list[/bold] to see available models."
        )
    return (
        "[yellow]Hint:[/yellow] No models available.\n"
        "  Pull a model first: [bold]ollama pull qwen3.5:2b[/bold]\n"
        "  Run [bold]jarvis model list[/bold] to see available models."
    )

mining_not_running_hint 

mining_not_running_hint(cfg: object | None, sidecar_present: bool) -> Optional[str]

Return a mining hint when configured but no session sidecar exists.

Source code in src/openjarvis/cli/hints.py 
48
49
50
51
52
def mining_not_running_hint(cfg: object | None, sidecar_present: bool) -> Optional[str]:
    """Return a mining hint when configured but no session sidecar exists."""
    if cfg is None or sidecar_present:
        return None
    return "mining configured but not running - start it with `jarvis mine start`"