Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion website/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
28 changes: 17 additions & 11 deletions website/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down