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.
This commit is contained in:
Arnold Wender
2026-04-15 09:26:20 +02:00
committed by GitHub
parent ced1fc955d
commit f36d04e4a4
2 changed files with 24 additions and 12 deletions
+7 -1
View File
@@ -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