jason/mempalace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(cli): clarify that 'mempalace init' requires <dir> (#210) (#862)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
website/reference/cli.md
+17 -11
View File
@@ -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`