From f36d04e4a4c9c191d0421336a74554bdaadbe384 Mon Sep 17 00:00:00 2001
From: Arnold Wender <arnold.wender@gmail.com>
Date: Wed, 15 Apr 2026 09:26:20 +0200
Subject: [PATCH] docs(cli): clarify that 'mempalace init' requires <dir>
 (#210) (#862)

Fixes #210.

The CLI requires a positional <dir> argument. Previous docs emphasized
that init 'sets up ~/.mempalace/' which misled users into expecting
no arguments. Now the docs show <dir> is required, offer '.' as the
usage for the current directory, and reword the description so the
project-directory scan is listed first.
---
 website/guide/getting-started.md |  8 +++++++-
 website/reference/cli.md         | 28 +++++++++++++++++-----------
 2 files changed, 24 insertions(+), 12 deletions(-)

diff --git a/website/guide/getting-started.md b/website/guide/getting-started.md
index db927e1..2dc921d 100644
--- a/website/guide/getting-started.md
+++ b/website/guide/getting-started.md
@@ -34,14 +34,20 @@ Three steps: **init**, **mine**, **search**.
 
 ### 1. Initialize Your Palace
 
+`mempalace init` requires a project directory to scan. Pass a path,
+or `.` to use the current directory.
+
 ```bash
 mempalace init ~/projects/myapp
+# or, from inside the project:
+mempalace init .
 ```
 
 This scans your project directory and:
+
 - Detects people and projects from file content
 - Creates rooms from your folder structure
-- Sets up `~/.mempalace/` config directory
+- Ensures the `~/.mempalace/` config directory exists
 
 ### 2. Mine Your Data
 
diff --git a/website/reference/cli.md b/website/reference/cli.md
index 3bf054c..d87b104 100644
--- a/website/reference/cli.md
+++ b/website/reference/cli.md
@@ -4,23 +4,29 @@ All commands accept `--palace <path>` to override the default palace location.
 
 ## `mempalace init`
 
-Detect rooms from your folder structure and set up the palace.
+Scan a project directory for people, projects, and rooms, and set up the palace.
 
 ```bash
-mempalace init <dir>
-mempalace init <dir> --yes  # non-interactive mode
+mempalace init <dir>                 # <dir> is required
+mempalace init <dir> --yes           # non-interactive mode
+mempalace init ~/projects/myapp      # example
+mempalace init .                     # initialize from the current directory
 ```
 
-| Option | Description |
-|--------|-------------|
-| `<dir>` | Project directory to scan |
-| `--yes` | Auto-accept all detected entities |
+| Option  | Description                                                                  |
+|---------|------------------------------------------------------------------------------|
+| `<dir>` | **Required.** Project directory to scan. Pass `.` for the current directory. |
+| `--yes` | Auto-accept all detected entities                                            |
 
 What it does:
-1. Scans for people and projects in file content
-2. Detects rooms from folder structure
-3. Creates `~/.mempalace/` config directory
-4. Saves detected entities to `<dir>/entities.json`
+
+1. Scans `<dir>` for people and projects in file content
+2. Detects rooms from `<dir>`'s folder structure
+3. Saves detected entities to `<dir>/entities.json`
+4. Ensures the global `~/.mempalace/` config directory exists
+
+Running `mempalace init` with no argument will exit with
+`error: the following arguments are required: dir`.
 
 ## `mempalace mine`