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
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,22 @@ Authentication and setup instructions vary by backend — refer to the relevant

The setup wizard optionally indexes your repositories with [ck](https://beaconbay.github.io/ck/) — a hybrid code search tool by [BeaconBay](https://github.com/beaconbay) that fuses lexical (BM25/grep) precision with embedding-based recall, so you can find the right code even when the exact keywords aren't there.


## Syncing Your Workbench

The workbench is periodically updated with improvements to slash commands, skills, schemas, and documentation. To fetch the latest managed files from the source repository, run `workbench --sync` from your workbench root:

```bash
workbench --sync
```

Sync clones the source, applies the configured file paths (`.opencode/`, `.workbench/schemas/`, `README.md`), and auto-commits changes with a chore message. An interactive confirmation prompt lets you review and abort before any files are overwritten.

Sync requires an initialized workbench (created via `workbench --init`) and a clean working tree. Run periodically to stay updated.

See [packages/workbench-cli/README.md](packages/workbench-cli/README.md) for full flag documentation and troubleshooting.


## Development Setup

To set up the workbench CLI for local development:
Expand Down
17 changes: 17 additions & 0 deletions packages/workbench-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,17 @@ These flags work with both `--init` and standalone usage:

> **What is ck?** [ck](https://beaconbay.github.io/ck/) is a hybrid code search tool by [BeaconBay](https://github.com/beaconbay) that fuses lexical (BM25/grep) precision with embedding-based recall, so you can find the right code even when the exact keywords aren't there.


## Sync

Fetches managed workbench files from the source repository and merges them into your local workbench. Sync clones the source, reads the configured `sync.paths`, prompts for confirmation, and auto-commits any changes. This keeps your workbench up to date with upstream improvements without manual file tracking.

| Flag | Description | Default |
|------|-------------|---------|
| `--sync` | Sync workbench files (`.opencode/`, `.workbench/schemas/`, `README.md`) from the source repository | `false` |

Sync requires an initialized workbench and a clean working tree. Run `workbench --sync` from your workbench root.

## Examples

```bash
Expand All @@ -107,6 +118,8 @@ workbench --org myorg --code-repository https://github.com/myorg/backend

# Interactive setup (existing repo)
workbench --tui
# Sync managed files from the source workbench
workbench --sync
```

## What the setup wizard does
Expand All @@ -129,6 +142,10 @@ Afterwards, `.workbench/config.yaml` is written with the selected configuration.
| `Remote creation failed` | `gh repo create` failed | Check `gh auth login` and org permissions |
| `gh CLI is not authenticated` | `gh auth` not set up | Run `gh auth login` |
| `Invalid name "X"` | Bad characters in name | Use only alphanumeric, `-`, `.`, `_` |
| `No .workbench/config.yaml found` | Workbench not initialized | Run `workbench --init` first |
| `No source.repository found in config` | Config predates sync feature | Re-initialize workbench |
| `Working tree is not clean` | Uncommitted changes present | Commit or stash changes first |
| `No sync.paths found in source` | Source workbench doesn't support sync | Contact source maintainer |

## Development

Expand Down
Loading