Skip to content

Personal AI, On Personal Devices

Python

docs: make preset replacement explicit (#894)

Elliot Slusky20263d689d6e
diff --git a/README.md b/README.md
index 282efb57..d7a74449 100644
--- a/README.md
+++ b/README.md
@@ -56,7 +56,7 @@ Platform-specific notes (WSL2 setup, native-Windows scheduled-task service, desk
```bash
jarvis # start chatting (default: chat-simple)
-jarvis init --preset <name> # switch to a starter config
+jarvis init --preset <name> --force # replace config with a starter preset
```
> Prefix `jarvis ...` with `uv run`, or `source .venv/bin/activate` first.
@@ -72,7 +72,7 @@ jarvis init --preset <name> # switch to a starter config
Example:
```bash
-jarvis init --preset morning-digest-mac
+jarvis init --preset morning-digest-mac --force
jarvis connect gdrive # one OAuth covers Gmail / Calendar / Tasks
jarvis digest --fresh # generate and play your first briefing
```
diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md
index f7c3597e..6b494936 100644
--- a/docs/getting-started/quickstart.md
+++ b/docs/getting-started/quickstart.md
@@ -69,7 +69,7 @@ OpenJarvis is a modular AI assistant framework. Here's what developers build wit
=== "Deep Research"
```bash
- jarvis init --preset deep-research
+ jarvis init --preset deep-research --force
jarvis memory index ~/Documents/papers/
jarvis ask "Summarize all documents about transformer architectures"
# Multi-hop search across your indexed docs with citations
@@ -78,7 +78,7 @@ OpenJarvis is a modular AI assistant framework. Here's what developers build wit
=== "Code Assistant"
```bash
- jarvis init --preset code-assistant
+ jarvis init --preset code-assistant --force
jarvis ask "Write a Python script that parses CSV files"
# Orchestrator agent with code execution, file I/O, and shell access
```
@@ -86,7 +86,7 @@ OpenJarvis is a modular AI assistant framework. Here's what developers build wit
=== "Scheduled Monitor"
```bash
- jarvis init --preset scheduled-monitor
+ jarvis init --preset scheduled-monitor --force
jarvis memory index ~/Documents/
jarvis scheduler start
jarvis scheduler create \
diff --git a/docs/user-guide/chat-simple.md b/docs/user-guide/chat-simple.md
index eaad5fb4..4bab5538 100644
--- a/docs/user-guide/chat-simple.md
+++ b/docs/user-guide/chat-simple.md
@@ -17,7 +17,7 @@ ollama pull qwen3.5:4b
git clone https://github.com/open-jarvis/OpenJarvis.git
cd OpenJarvis
uv sync
-jarvis init --preset chat-simple
+jarvis init --preset chat-simple --force
```
### 3. Ask a question
diff --git a/docs/user-guide/code-assistant.md b/docs/user-guide/code-assistant.md
index f124b698..b433197d 100644
--- a/docs/user-guide/code-assistant.md
+++ b/docs/user-guide/code-assistant.md
@@ -10,7 +10,7 @@ An orchestrator agent with code execution, file I/O, and shell access. It can wr
git clone https://github.com/open-jarvis/OpenJarvis.git
cd OpenJarvis
uv sync --extra dev
-jarvis init --preset code-assistant
+jarvis init --preset code-assistant --force
```
This writes a pre-configured `~/.openjarvis/config.toml` for the code assistant.
diff --git a/docs/user-guide/deep-research.md b/docs/user-guide/deep-research.md
index 98c1ccbb..cb638c0d 100644
--- a/docs/user-guide/deep-research.md
+++ b/docs/user-guide/deep-research.md
@@ -10,7 +10,7 @@ A multi-hop research agent that searches across your indexed documents, cross-re
git clone https://github.com/open-jarvis/OpenJarvis.git
cd OpenJarvis
uv sync --extra dev
-jarvis init --preset deep-research
+jarvis init --preset deep-research --force
```
This writes a pre-configured `~/.openjarvis/config.toml` for the deep research agent.
diff --git a/docs/user-guide/scheduled-monitor.md b/docs/user-guide/scheduled-monitor.md
index 4b7f91b8..ffc716de 100644
--- a/docs/user-guide/scheduled-monitor.md
+++ b/docs/user-guide/scheduled-monitor.md
@@ -10,7 +10,7 @@ A persistent operative agent that runs on a cron schedule, maintains state acros
git clone https://github.com/open-jarvis/OpenJarvis.git
cd OpenJarvis
uv sync --extra dev
-jarvis init --preset scheduled-monitor
+jarvis init --preset scheduled-monitor --force
```
This writes a pre-configured `~/.openjarvis/config.toml` for the operative agent with scheduling support.
diff --git a/src/openjarvis/cli/init_cmd.py b/src/openjarvis/cli/init_cmd.py
index 35cb51bc..affc1083 100644
--- a/src/openjarvis/cli/init_cmd.py
+++ b/src/openjarvis/cli/init_cmd.py
@@ -322,7 +322,13 @@ def init(
console.print(
f"[yellow]Config already exists at {DEFAULT_CONFIG_PATH}[/yellow]"
)
- console.print("Use [bold]--force[/bold] to overwrite.")
+ if preset:
+ console.print(
+ "Switching presets replaces the existing config. Re-run with "
+ f"[bold]jarvis init --preset {preset} --force[/bold] to confirm."
+ )
+ else:
+ console.print("Use [bold]--force[/bold] to overwrite.")
raise SystemExit(1)
# Handle --preset: copy a starter config and return early
diff --git a/tests/cli/test_cli.py b/tests/cli/test_cli.py
index 0ec3c12d..5d1a5bd1 100644
--- a/tests/cli/test_cli.py
+++ b/tests/cli/test_cli.py
@@ -170,6 +170,37 @@ class TestCLI:
encoding="utf-8"
)
+ def test_preset_switch_requires_explicit_force(self, tmp_path: Path) -> None:
+ config_dir = tmp_path / ".openjarvis"
+ config_dir.mkdir()
+ config_path = config_dir / "config.toml"
+ original = '# customized\n[engine]\ndefault = "ollama"\n'
+ config_path.write_text(original, encoding="utf-8")
+
+ with (
+ mock.patch("openjarvis.cli.init_cmd.DEFAULT_CONFIG_DIR", config_dir),
+ mock.patch("openjarvis.cli.init_cmd.DEFAULT_CONFIG_PATH", config_path),
+ ):
+ rejected = CliRunner().invoke(
+ cli,
+ ["init", "--preset", "chat-simple"],
+ )
+ assert config_path.read_text(encoding="utf-8") == original
+ confirmed = CliRunner().invoke(
+ cli,
+ ["init", "--preset", "chat-simple", "--force"],
+ )
+
+ assert rejected.exit_code != 0
+ assert "jarvis init --preset chat-simple --force" in " ".join(
+ rejected.output.split()
+ )
+ assert confirmed.exit_code == 0
+ assert config_path.read_text(encoding="utf-8") != original
+ assert "lightweight conversational AI" in config_path.read_text(
+ encoding="utf-8"
+ )
+
class TestStartupResilience:
"""Importing the CLI must not force heavy/native deps (#404, #309).