Skip to content

docs: add self-contained install, verify, and recovery guidance (AX-2162) #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YoniMelki wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: add self-contained install, verify, and recovery guidance (AX-2162) #38

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba89ffa
AX-2162 - Align OpenCode README with shared flow and AX cross-links
YoniMelki Aug 25, 2026
e7f95d7
AX-2162 - Keep OpenCode install docs self-contained
YoniMelki Aug 25, 2026
d73dc53
Remove internal ticket links from the README
YoniMelki Aug 25, 2026
c907a92
Add a Recovery heading and the install-docs CI guard.
YoniMelki Aug 27, 2026
ce7a987
Drop the install-docs README checker.
YoniMelki Aug 27, 2026
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
39 changes: 39 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,19 @@ release. For an organization-wide rollout, set the plugin in OpenCode's
[remote configuration](https://opencode.ai/docs/config/#remote) so every developer
gets it automatically.

**Restart OpenCode completely** after editing `opencode.json` or changing any JFrog
environment variable. Starting a new session, or reloading the window, is not enough —
the plugin reads its configuration at load time.

#### Config file location

| Platform | Path |
| --- | --- |
| macOS / Linux | `~/.config/opencode/opencode.json` |
| Windows | `%APPDATA%\opencode\opencode.json` |

OpenCode Desktop and the CLI share this config.

### Local development

Test an uncommitted checkout without publishing. Build the module, then point your
Expand Down Expand Up @@ -146,6 +159,32 @@ skill's body loads only when it is invoked.

---

## Verify

Verification is a required install step, not a troubleshooting fallback. After
restarting OpenCode, confirm all four:

1. OpenCode's startup output resolves `@jfrog/opencode-jfrog-plugin` without a plugin load error.
2. `/skills` in a session — `jfrog` and the other bundled skills are listed.
3. `opencode mcp list` — `jfrog` shows as connected after `opencode mcp auth jfrog`.
(Skip this if you set `JFROG_MCP_DISABLE=true`.)
4. `jf rt ping` — succeeds against your configured JFrog server.

Skills loading while the MCP stays disconnected usually means `JFROG_PLATFORM_URL` was
set after OpenCode started, or the OAuth sign-in has not been completed. Setting
environment variables without a full restart does not repair it. If a check fails,
see [Recovery](#recovery).

## Recovery

| Symptom | Do this | Do **not** do this |
| --- | --- | --- |
| MCP disconnected after install | Set `JFROG_PLATFORM_URL` in the environment that **launches** OpenCode, run `opencode mcp auth jfrog`, **quit and restart OpenCode**, then `opencode mcp list`. | Expect a new session or window reload to pick up env vars. |
| Skills load but MCP is missing | Confirm `JFROG_MCP_DISABLE` is not `true`, set the host before start, complete OAuth. | Set `JFROG_ACCESS_TOKEN` — MCP auth is OAuth only. |
| Config change not applied | Edit `opencode.json`, then fully quit and restart OpenCode. | Start a new chat without restarting. |

---

## Usage

Once configured, interact with the JFrog plugin through natural language. Examples are
Expand Down
Loading