[ide-mode] Add docs on running the vscode companion extension locally (#6145)

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Shreya <shreyakeshive@google.com>
Co-authored-by: Shreya Keshive <skeshive@gmail.com>
This commit is contained in:
christine betts 2025-08-14 17:47:36 +00:00 committed by GitHub
parent ef54f720de
commit 2416a80e9c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 32 additions and 2 deletions

View File

@ -1,6 +1,6 @@
# Gemini CLI Companion # Gemini CLI Companion
The Gemini CLI Companion extension seamlessly integrates [Gemini CLI](https://github.com/google-gemini/gemini-cli) into your IDE. The Gemini CLI Companion extension pairs with [Gemini CLI](https://github.com/google-gemini/gemini-cli). This extension is compatible with both VS Code and VS Code forks.
# Features # Features

View File

@ -0,0 +1,30 @@
# Local Development
## Running the Extension
To run the extension locally for development:
1. From the root of the repository, install dependencies:
```bash
npm install
```
2. Open this directory (`packages/vscode-ide-companion`) in VS Code.
3. Compile the extension:
```bash
npm run compile
```
4. Press `F5` (fn+f5 on mac) to open a new Extension Development Host window with the extension running.
To watch for changes and have the extension rebuild automatically, run:
```bash
npm run watch
```
## Running Tests
To run the automated tests, run:
```bash
npm run test
```

View File

@ -1,7 +1,7 @@
{ {
"name": "gemini-cli-vscode-ide-companion", "name": "gemini-cli-vscode-ide-companion",
"displayName": "Gemini CLI Companion", "displayName": "Gemini CLI Companion",
"description": "Enable Gemini CLI with direct access to your VS Code workspace.", "description": "Enable Gemini CLI with direct access to your IDE workspace.",
"version": "0.1.19", "version": "0.1.19",
"publisher": "google", "publisher": "google",
"icon": "assets/icon.png", "icon": "assets/icon.png",