diff options
| author | christine betts <[email protected]> | 2025-08-14 17:47:36 +0000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-08-14 17:47:36 +0000 |
| commit | 2416a80e9c1d12718e5cf02db8582cff4c9a5942 (patch) | |
| tree | 2cf142679dbb83a3cb87738e5e54cc768d9e3608 | |
| parent | ef54f720de0ed9e94677504b21d437a79fec89fd (diff) | |
[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 <[email protected]>
Co-authored-by: Shreya Keshive <[email protected]>
| -rw-r--r-- | packages/vscode-ide-companion/README.md | 2 | ||||
| -rw-r--r-- | packages/vscode-ide-companion/development.md | 30 | ||||
| -rw-r--r-- | packages/vscode-ide-companion/package.json | 2 |
3 files changed, 32 insertions, 2 deletions
diff --git a/packages/vscode-ide-companion/README.md b/packages/vscode-ide-companion/README.md index ebc751e6..6e6db38d 100644 --- a/packages/vscode-ide-companion/README.md +++ b/packages/vscode-ide-companion/README.md @@ -1,6 +1,6 @@ # 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 diff --git a/packages/vscode-ide-companion/development.md b/packages/vscode-ide-companion/development.md new file mode 100644 index 00000000..0fdc93f2 --- /dev/null +++ b/packages/vscode-ide-companion/development.md @@ -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 +``` diff --git a/packages/vscode-ide-companion/package.json b/packages/vscode-ide-companion/package.json index 4cbf9bb1..187da3e8 100644 --- a/packages/vscode-ide-companion/package.json +++ b/packages/vscode-ide-companion/package.json @@ -1,7 +1,7 @@ { "name": "gemini-cli-vscode-ide-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", "publisher": "google", "icon": "assets/icon.png", |