Skip to content

AX-2162: Document VS Code install, verify, and recovery #61

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 6 commits into
base: main
Choose a base branch
from
Open

AX-2162: Document VS Code install, verify, and recovery #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8f763a4
AX-2162 - Align VS Code README with shared install verify recovery flow
YoniMelki Aug 25, 2026
fd71644
AX-2162 - Keep VS Code install docs self-contained
YoniMelki Aug 25, 2026
a77e618
AX-2162 - Document JFROG_PLATFORM_URL instead of JFROG_URL
YoniMelki Aug 25, 2026
d3c7467
Add a Recovery heading and the install-docs CI guard.
YoniMelki Aug 27, 2026
ea81f37
Drop the install-docs README checker and keep this repo self-contained.
YoniMelki Aug 27, 2026
bedc29b
Restore vendored modules to the jfrog-agent-hooks copy.
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
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ VS Code opens, prompts you to install the plugin, and asks you to **Trust** the

| Variable | Description |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `JFROG_URL` | Your JFrog platform URL, e.g. `https://mycompany.jfrog.io` (no trailing `/`). |
| `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`). |
| `JFROG_ACCESS_TOKEN` | Your JFrog access token |

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

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`.

---

## Verify

Verification is a required install step, not a troubleshooting fallback:

1. The plugin appears in Copilot's installed plugins list.
2. **`/jfrog-init`** completes without blocking errors.
3. **Reload the VS Code window**, open a **new** Copilot chat, and enable the JFrog MCP tools in the tool picker.
4. `jf rt ping` — succeeds against your configured server.

If a check fails, see [Recovery](#recovery). Fix the step `/jfrog-init` reports, re-run it, and reload the window.

## Recovery

| Symptom | Do this | Do **not** do this |
| --- | --- | --- |
| 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. |
| `/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. |
| 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. |

---

## Usage
Expand Down
7 changes: 2 additions & 5 deletions docs/package-resolution-user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,9 @@ To turn it off in the config file itself, set `"enabled": false`. If your file i

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.

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

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

---

Expand Down
Loading