Skip to content

Commit e79c2be

Browse files
AX-2162: Document VS Code install, verify, and recovery (#61)
* AX-2162 - Align VS Code README with shared install verify recovery flow Co-authored-by: Cursor <cursoragent@cursor.com> * AX-2162 - Keep VS Code install docs self-contained Inline verify and recovery in this README instead of sending readers to the Claude plugin repository. Co-authored-by: Cursor <cursoragent@cursor.com> * AX-2162 - Document JFROG_PLATFORM_URL instead of JFROG_URL Remove the legacy JFROG_URL row from the auth table. The documented host variable is JFROG_PLATFORM_URL. Co-authored-by: Cursor <cursoragent@cursor.com> * Add a Recovery heading and the install-docs CI guard. * Drop the install-docs README checker and keep this repo self-contained. * Restore vendored modules to the jfrog-agent-hooks copy. --------- Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent af6b9fe commit e79c2be

2 files changed

Lines changed: 25 additions & 6 deletions

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ VS Code opens, prompts you to install the plugin, and asks you to **Trust** the
8686

8787
| Variable | Description |
8888
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
89-
| `JFROG_URL` | Your JFrog platform URL, e.g. `https://mycompany.jfrog.io` (no trailing `/`). |
9089
| `JFROG_PLATFORM_URL` | Your JFrog platform host, **without** the scheme, e.g. `mycompany.jfrog.io`. Resolves the JFrog MCP server URL (`https://${env:JFROG_PLATFORM_URL}/mcp`). |
9190
| `JFROG_ACCESS_TOKEN` | Your JFrog access token |
9291

@@ -101,6 +100,29 @@ If you have never configured the JFrog CLI on this machine:
101100
```
102101
3. Follow the interactive prompts to enter the same JFrog platform URL and access token.
103102

103+
Run **`/jfrog-init`** in Copilot Chat after install. **Reload the VS Code window** after MCP config changes (a new chat alone is not enough). Setting `JFROG_PLATFORM_URL` / `JFROG_ACCESS_TOKEN` does not repair a failed init walk — fix the reported step and re-run `/jfrog-init`.
104+
105+
---
106+
107+
## Verify
108+
109+
Verification is a required install step, not a troubleshooting fallback:
110+
111+
1. The plugin appears in Copilot's installed plugins list.
112+
2. **`/jfrog-init`** completes without blocking errors.
113+
3. **Reload the VS Code window**, open a **new** Copilot chat, and enable the JFrog MCP tools in the tool picker.
114+
4. `jf rt ping` — succeeds against your configured server.
115+
116+
If a check fails, see [Recovery](#recovery). Fix the step `/jfrog-init` reports, re-run it, and reload the window.
117+
118+
## Recovery
119+
120+
| Symptom | Do this | Do **not** do this |
121+
| --- | --- | --- |
122+
| MCP missing after install | Run `/jfrog-init`, **reload the VS Code window**, open a **new** Copilot chat, enable JFrog MCP tools. | Assume a new chat without a window reload will pick up MCP changes. |
123+
| `/jfrog-init` stopped at CLI/auth | Follow the skill prompt (`jf config add`, web login, or token path), then **re-run `/jfrog-init`**. | Skip init and only export env vars. |
124+
| Env vars set after a failed init | Fix the reported step, re-run `/jfrog-init`, reload the window. | Expect `JFROG_PLATFORM_URL` alone to substitute the MCP host. |
125+
104126
---
105127

106128
## Usage

docs/package-resolution-user-guide.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,9 @@ To turn it off in the config file itself, set `"enabled": false`. If your file i
101101

102102
This is a preview, and your feedback directly shapes what ships next. Please tell us about anything that felt confusing, broken, or surprising, good or bad.
103103

104-
File an issue on GitHub, in whichever plugin repo you use:
104+
File an issue on GitHub: [github.com/jfrog/vscode-plugin/issues](https://github.com/jfrog/vscode-plugin/issues)
105105

106-
- Cursor: [github.com/jfrog/cursor-plugin/issues](https://github.com/jfrog/cursor-plugin/issues)
107-
- Claude Code: [github.com/jfrog/claude-plugin/issues](https://github.com/jfrog/claude-plugin/issues)
108-
- VS Code: [github.com/jfrog/vscode-plugin/issues](https://github.com/jfrog/vscode-plugin/issues)
109-
- Email: plugins-feedback@jfrog.com
106+
Email: plugins-feedback@jfrog.com
110107

111108
---
112109

0 commit comments

Comments
 (0)