Skip to content

VS Code Plugin

The Archgate VS Code plugin gives AI agents working in VS Code built-in guardrails. Agents read your ADRs before writing code, validate after, and capture new patterns for the team — the same workflow available in the Claude Code plugin.

VS Code supports agent plugins installed from git-based marketplaces. The Archgate plugin is served from a git repository at plugins.archgate.dev/archgate/vscode.git. When you add this marketplace to your VS Code user settings, VS Code discovers and installs the plugin automatically.

The plugin is served in VS Code Copilot’s native .github/plugin/ manifest format, separate from the Claude Code .claude-plugin/ format.

Log in to obtain plugin access:

Terminal window
archgate login

This starts an OAuth 2.0 Device Authorization Grant against the Archgate platform. The CLI displays a one-time code and URL — open the URL in your browser, enter the code, and authorize. Once complete, the resulting tokens are handed to your configured git credential helper via git credential approve; an OS-backed helper keeps them encrypted, while git’s built-in store helper writes them in plain text.

2. Initialize your project with the plugin

Section titled “2. Initialize your project with the plugin”

Run archgate init with the --editor vscode flag:

Terminal window
archgate init --editor vscode

If you are already logged in, this command:

  1. Creates the .archgate/ directory with ADRs and lint rules
  2. Adds the marketplace URL to your VS Code user settings

archgate init does not download the VS Code extension. To install the extension itself, run archgate plugin install --editor vscode (see below).

The chat.plugins.marketplaces setting is application-scoped in VS Code, so it cannot be set per-workspace. The CLI automatically writes it to your user-level settings.json:

PlatformUser settings path
Windows%APPDATA%\Code\User\settings.json
macOS~/Library/Application Support/Code/User/settings.json
Linux~/.config/Code/User/settings.json
WSLThe Windows-side path above (VS Code runs on Windows)

To install or reinstall the extension on an already-initialized project:

Terminal window
archgate plugin install --editor vscode

Without --editor, an interactive run detects the editors installed on your machine and lets you pick; a non-interactive run (an agent or CI) defaults to Claude Code.

This re-writes the marketplace URL into your user settings and, when the code CLI is on your PATH, downloads the Archgate VS Code extension from the plugins service and installs it via code --install-extension. If the code CLI is not available, manual installation instructions are printed. If the install itself fails, the downloaded .vsix is kept at ~/.archgate/archgate.vsix so you can install it by hand.

The commands create or update the following:

FileScopePurpose
User settings.jsonUserchat.plugins.marketplaces with the Archgate marketplace URL (init)
Archgate extensionApplicationVS Code extension installed via .vsix (archgate plugin install)

The user settings file is merged additively — existing settings are never overwritten. VS Code’s built-in default marketplaces (github/copilot-plugins, github/awesome-copilot) are preserved when the key is set for the first time.

The user-level marketplace setting (added to your settings.json):

{
"chat.plugins.marketplaces": [
"https://plugins.archgate.dev/archgate/vscode.git"
]
}

The URL carries no credentials. archgate credential is the credential helper; archgate login registers it for plugins.archgate.dev. Git asks it on each request and receives a valid access token, renewed only when the cached one has lapsed.

If you prefer not to let the CLI modify your user settings, you can set things up manually:

Marketplace URL: Open VS Code’s user settings JSON (Ctrl+Shift+P → “Preferences: Open User Settings (JSON)”) and add the chat.plugins.marketplaces entry shown above. You can print the URL by running archgate plugin url --editor vscode.

Extension: Download and install the .vsix file directly:

Terminal window
printf 'protocol=https\nhost=plugins.archgate.dev\n\n' |
archgate credential get |
sed -n 's|^password=\(.*\)|header = "Authorization: Bearer \1"|p' |
curl --config - --fail --silent --show-error --output archgate.vsix https://plugins.archgate.dev/api/vscode &&
code --install-extension archgate.vsix
rm -f archgate.vsix

archgate credential get emits a git credential response, so the password= line is reshaped into a curl --config directive and piped in. The token never reaches the command line, where it would be visible in the process list and your shell history. --fail makes curl exit non-zero on a 401 rather than writing the error body over archgate.vsix, and && keeps code from installing anything curl did not finish downloading; the final rm -f cleans up either way.

Prefer the marketplace setup above where you can: it lets git ask the helper on every request, so no token is handled by hand at all.

The plugin adds agents and role-based skills to VS Code’s AI. The developer agent orchestrates the guardrails workflow, invoking skills as needed.

AgentPurpose
archgate:developerGeneral development agent that reads ADRs before coding and validates after
archgate:plannerPlanning agent for scoping work and breaking tasks into ADR-compliant steps

The archgate:developer agent is set as the default agent via the plugin settings. It orchestrates the skills below automatically as part of its workflow.

SkillPurpose
archgate:reviewerValidates code changes against all project ADRs for structural compliance
archgate:lessons-learnedCaptures learnings and proposes new ADRs when patterns emerge
archgate:adr-authorCreates and edits ADRs following project conventions
archgate:onboardOne-time setup: explores the codebase, interviews the developer, creates initial ADRs
archgate:cli-referenceInternal reference for AI agents with the complete Archgate CLI command guide

After installation, run the archgate:onboard skill in your project once. This skill:

  1. Explores your codebase structure (directories, key files, package configuration)
  2. Interviews you about your team’s conventions, constraints, and architectural decisions
  3. Creates an initial set of ADRs based on your responses
  4. Sets up the .archgate/ directory with your first rules

The onboard skill is designed to run once per project. After onboarding, the other skills handle day-to-day development.

The plugin follows a structured workflow for every coding task:

When the developer gives a coding task, the agent runs archgate review-context to read all ADRs that apply to the files being changed. This provides a condensed briefing with the Decision and Do’s and Don’ts sections from each relevant ADR.

The agent writes code that complies with the constraints from the ADRs. The Do’s and Don’ts sections serve as concrete guardrails.

After writing code, the agent runs archgate check to execute automated rules against the changes. Any violations are fixed before proceeding.

The agent invokes archgate:reviewer to validate structural ADR compliance beyond what automated rules catch.

The agent invokes archgate:lessons-learned to review the work and identify patterns worth capturing as new ADRs.

  • Each developer runs archgate init --editor vscode after archgate login to configure their user-level marketplace URL, then archgate plugin install --editor vscode to install the extension.
  • Run onboard once per project to generate your initial ADRs from your actual codebase.
  • Keep ADR rule files up to date — the agent enforces what the rules check for.