Skip to content

Commit 436ef83

Browse files
docs(ocm-cli): update plugin config to tui-only entry and clarify session history source
1 parent b4dd57a commit 436ef83

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/ocm-cli.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,20 +29,20 @@ The CLI is published as `@opencode-manager/ocm-cli`. There are two install paths
2929

3030
### Option A — install via OpenCode's plugin loader (recommended)
3131

32-
Add the package to your OpenCode config and OpenCode will fetch it on next start. The package's plugin entry self-installs a `~/.local/bin/ocm` symlink, so the `ocm` binary becomes available on your PATH automatically.
32+
Add the TUI plugin entry to your OpenCode config and OpenCode will fetch the package on next start. The package `postinstall` script self-installs a `~/.local/bin/ocm` symlink for local plugin installs, so the `ocm` binary becomes available on your PATH automatically.
3333

3434
```jsonc
3535
// ~/.config/opencode/opencode.json
3636
{
3737
"$schema": "https://opencode.ai/config.json",
38-
"plugin": ["@opencode-manager/ocm-cli", "@opencode-manager/ocm-cli/tui"]
38+
"plugin": ["@opencode-manager/ocm-cli/tui"]
3939
}
4040
```
4141

42-
The next time OpenCode starts it will run `bun install` for the plugin and import it once. You'll see:
42+
The next time OpenCode starts it will run `bun install` for the plugin. You'll see:
4343

4444
```
45-
ocm-cli: installed `ocm` at /Users/you/.local/bin/ocm
45+
ocm installed at /Users/you/.local/bin/ocm
4646
```
4747

4848
If `~/.local/bin` is not on your PATH, the message will tell you. Add this to your shell rc:
@@ -51,7 +51,7 @@ If `~/.local/bin` is not on your PATH, the message will tell you. Add this to yo
5151
export PATH="$HOME/.local/bin:$PATH"
5252
```
5353

54-
The default plugin entry only installs the bin symlink. The `./tui` entry registers `/ocm-move`, a TUI command that keeps the local session and copies the active session to the Manager after pushing the current repo state. Run it from inside a local OpenCode session after `ocm login` and after the repo exists on the Manager (`ocm push --create` if needed).
54+
The `./tui` entry registers `/ocm-move`, a TUI command that keeps the local session and copies the active session to the Manager after pushing the current repo state. Run it from inside a local OpenCode session after `ocm login` and after the repo exists on the Manager (`ocm push --create` if needed).
5555

5656
### Option B — global package manager install
5757

@@ -131,7 +131,7 @@ The child takes over the terminal (`stdio: inherit`); closing the TUI exits `ocm
131131

132132
### TUI `/ocm-move`
133133

134-
When the TUI plugin entry is installed, `/ocm-move` is available in local OpenCode sessions. It checks that the matching Manager repo has not diverged, pushes the local git state with the fast bundle + working-tree patch path, exports the active session history from the local OpenCode `/sync` API, rewrites local repo directories to the Manager repo directory, and replays the session through `/api/opencode-proxy/sync/replay`. The local session is retained.
134+
When the TUI plugin entry is installed, `/ocm-move` is available in local OpenCode sessions. It checks that the matching Manager repo has not diverged, pushes the local git state with the fast bundle + working-tree patch path, reads the active session history from the local OpenCode SQLite event database, rewrites local repo directories to the Manager repo directory, and replays the session through `/api/opencode-proxy/sync/replay`. The local session is retained.
135135

136136
- `--force` skips the dirty-working-tree check on `pull` and the safety bail on `push`.
137137
- `--create` (on `push`) creates a new Manager repo when no `origin` match is found.

0 commit comments

Comments
 (0)