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:
@@ -34,14 +34,20 @@ Three steps: **init**, **mine**, **search**.
|
|||||||
|
|
||||||
### 1. Initialize Your Palace
|
### 1. Initialize Your Palace
|
||||||
|
|
||||||
|
`mempalace init` requires a project directory to scan. Pass a path,
|
||||||
|
or `.` to use the current directory.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mempalace init ~/projects/myapp
|
mempalace init ~/projects/myapp
|
||||||
|
# or, from inside the project:
|
||||||
|
mempalace init .
|
||||||
```
|
```
|
||||||
|
|
||||||
This scans your project directory and:
|
This scans your project directory and:
|
||||||
|
|
||||||
- Detects people and projects from file content
|
- Detects people and projects from file content
|
||||||
- Creates rooms from your folder structure
|
- Creates rooms from your folder structure
|
||||||
- Sets up `~/.mempalace/` config directory
|
- Ensures the `~/.mempalace/` config directory exists
|
||||||
|
|
||||||
### 2. Mine Your Data
|
### 2. Mine Your Data
|
||||||
|
|
||||||
|
|||||||
@@ -4,23 +4,29 @@ All commands accept `--palace <path>` to override the default palace location.
|
|||||||
|
|
||||||
## `mempalace init`
|
## `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
|
```bash
|
||||||
mempalace init <dir>
|
mempalace init <dir> # <dir> is required
|
||||||
mempalace init <dir> --yes # non-interactive mode
|
mempalace init <dir> --yes # non-interactive mode
|
||||||
|
mempalace init ~/projects/myapp # example
|
||||||
|
mempalace init . # initialize from the current directory
|
||||||
```
|
```
|
||||||
|
|
||||||
| Option | Description |
|
| Option | Description |
|
||||||
|--------|-------------|
|
|---------|------------------------------------------------------------------------------|
|
||||||
| `<dir>` | Project directory to scan |
|
| `<dir>` | **Required.** Project directory to scan. Pass `.` for the current directory. |
|
||||||
| `--yes` | Auto-accept all detected entities |
|
| `--yes` | Auto-accept all detected entities |
|
||||||
|
|
||||||
What it does:
|
What it does:
|
||||||
1. Scans for people and projects in file content
|
|
||||||
2. Detects rooms from folder structure
|
1. Scans `<dir>` for people and projects in file content
|
||||||
3. Creates `~/.mempalace/` config directory
|
2. Detects rooms from `<dir>`'s folder structure
|
||||||
4. Saves detected entities to `<dir>/entities.json`
|
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`
|
## `mempalace mine`
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user