Skip to content

Commit 052d1d1

Browse files
TheStreamCodeTheStreamCode
committed
chore: prepare v0.1.2 release
- Remove background version check and upgrade flow (Copilot CLI updates automatically) - Change default CLI command from 'gh copilot' to 'copilot' - Remove checkForUpdates setting - Update documentation and repository URLs - Format changelog following Keep a Changelog standard
0 parents  commit 052d1d1

19 files changed

Lines changed: 5463 additions & 0 deletions

‎.github/workflows/ci.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
check:
11+
strategy:
12+
matrix:
13+
os: [windows-latest, ubuntu-latest]
14+
15+
runs-on: ${{ matrix.os }}
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Set up Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: '22'
24+
cache: npm
25+
26+
- name: Install dependencies
27+
run: npm ci
28+
29+
- name: Verify
30+
run: npm run check
31+
env:
32+
DISPLAY: ':99.0'

‎.gitignore‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
node_modules/
2+
out/
3+
out/**/*.map
4+
.copilot/
5+
*.vsix
6+
*.tgz
7+
.vscode-test/
8+
.vsce/
9+
coverage/
10+
*.log
11+
*.tsbuildinfo
12+
.DS_Store
13+
Thumbs.db
14+
Screenshot_*.jpeg

‎.vscodeignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
src/**
2+
test/**
3+
docs/**
4+
scripts/**
5+
node_modules/**
6+
.git/**
7+
.gitignore
8+
.github/**
9+
.copilot/**
10+
.vscode/**
11+
.vsce/**
12+
*.vsix
13+
*.log
14+
Screenshot_*.jpeg
15+
out/**/*.map
16+
*.tsbuildinfo
17+
tsconfig.json
18+
package-lock.json

‎CHANGELOG.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
6+
7+
## [0.1.2]
8+
9+
### Changed
10+
11+
- Changed the default CLI command from `gh copilot` to `copilot`.
12+
- Removed the background version check and one-click upgrade flow (Copilot CLI now updates automatically).
13+
- Removed the `copilotCliLauncher.checkForUpdates` setting.
14+
15+
## [0.1.1]
16+
17+
### Changed
18+
19+
- Updated Marketplace icon and toolbar launcher mark assets.
20+
21+
## [0.1.0]
22+
23+
### Added
24+
25+
- Initial release.
26+
- Toolbar button to launch GitHub Copilot CLI in a side terminal.
27+
- Install detection for `gh` CLI and the `gh-copilot` extension with guided warnings.
28+
- Configurable CLI command and terminal name.
29+
- Smart working directory resolution from the active editor.
30+
- Windows, macOS, and Linux support.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Michael Gasperini
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# GitHub Copilot CLI launcher
2+
3+
[![CI](https://github.com/TheStreamCode/github-copilot-cli-launcher/actions/workflows/ci.yml/badge.svg)](https://github.com/TheStreamCode/github-copilot-cli-launcher/actions/workflows/ci.yml)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
5+
6+
A VS Code extension that opens GitHub Copilot CLI in a new side terminal directly from the editor toolbar. One click, fresh terminal, ready to go.
7+
8+
Works on Windows, macOS, and Linux.
9+
10+
> **Disclaimer**
11+
> This extension is unofficial and is not affiliated with, endorsed by, or sponsored by GitHub or Microsoft. "GitHub Copilot" is a trademark of GitHub, Inc.
12+
13+
## Features
14+
15+
- **Toolbar launcher** — one-click button in the editor title area to start Copilot CLI
16+
- **Side-by-side terminal** — opens beside the active editor, never reusing existing terminals
17+
- **Smart working directory** — uses the active editor's workspace folder, with fallback to the first workspace
18+
- **Install detection** — shows guided warnings when `gh` or the `gh-copilot` extension is missing
19+
- **Configurable** — customize the CLI command and terminal label via VS Code settings
20+
- **Windows-ready** — supports quoted executable paths with spaces
21+
- **Privacy-first** — no telemetry, analytics, or personal data collection
22+
23+
## Requirements
24+
25+
- VS Code `^1.86.0`
26+
- [GitHub CLI (`gh`)](https://cli.github.com/) available in the integrated terminal
27+
- `gh-copilot` extension installed (`gh extension install github/gh-copilot`)
28+
29+
## Installation
30+
31+
1. **Install the extension** from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=mikesoft.vscode-copilot-cli-launcher).
32+
33+
2. **Install GitHub CLI:**
34+
35+
```bash
36+
# macOS
37+
brew install gh
38+
39+
# Windows (winget)
40+
winget install --id GitHub.cli
41+
42+
# Linux — see https://cli.github.com/ for your distribution
43+
```
44+
45+
3. **Install the Copilot CLI extension:**
46+
47+
```bash
48+
gh extension install github/gh-copilot
49+
```
50+
51+
4. Open any file in VS Code and click the launcher button in the editor title.
52+
53+
## How It Works
54+
55+
Each launch creates a new terminal beside the current editor and sends the configured command immediately. Existing terminals are never reused.
56+
57+
The launcher prefers the workspace folder of the active editor for the terminal's working directory. If the active editor is outside the workspace, it falls back to the first workspace folder.
58+
59+
When the terminal runs, the extension checks command availability and surfaces guided warnings if `gh` or the `gh-copilot` extension is missing — making problems easier to understand than relying on terminal output alone.
60+
61+
## Configuration
62+
63+
| Setting | Default | Description |
64+
| --- | --- | --- |
65+
| `copilotCliLauncher.cliCommand` | `copilot` | Command executed when the launcher button is clicked. |
66+
| `copilotCliLauncher.terminalName` | `GitHub Copilot CLI` | Base label used for the created terminal. |
67+
68+
Open settings via the Command Palette: **GitHub Copilot CLI launcher: Open Settings**
69+
70+
**Examples:**
71+
72+
Default command:
73+
74+
```json
75+
"copilotCliLauncher.cliCommand": "copilot"
76+
```
77+
78+
Windows executable path with spaces:
79+
80+
```json
81+
"copilotCliLauncher.cliCommand": "\"C:\\Program Files\\GitHub CLI\\gh.exe\" copilot"
82+
```
83+
84+
## Troubleshooting
85+
86+
### `gh` is not recognized
87+
88+
Install the GitHub CLI from [https://cli.github.com/](https://cli.github.com/) and confirm that `gh` works in a regular integrated terminal. If your setup relies on shell initialization, restart VS Code after installation so new terminals inherit the updated environment.
89+
90+
The extension also shows a VS Code warning dialog to make the issue clearer.
91+
92+
### The gh-copilot extension is not installed
93+
94+
Install it with:
95+
96+
```bash
97+
gh extension install github/gh-copilot
98+
```
99+
100+
### Nothing happens after clicking the button
101+
102+
Check the value of `copilotCliLauncher.cliCommand` in settings and verify that the same command works in a regular terminal.
103+
104+
### Custom executable path on Windows
105+
106+
Quote executable paths that contain spaces, for example: `"C:\Program Files\GitHub CLI\gh.exe" copilot`.
107+
108+
### Multi-root workspaces
109+
110+
The launcher uses the workspace folder of the active editor. To control where Copilot CLI starts in a multi-root window, open a file from the target workspace before clicking the toolbar button.
111+
112+
## Privacy
113+
114+
GitHub Copilot CLI launcher does not collect telemetry, analytics, or personal data.
115+
116+
## Development
117+
118+
```bash
119+
npm install
120+
npm run check
121+
npm run test:integration
122+
npm run package
123+
```
124+
125+
`npm run package` creates the `.vsix` file in the workspace root.
126+
127+
The repository includes unit tests, metadata checks, VS Code integration smoke tests, and CI coverage for Windows and Linux.
128+
129+
## Support
130+
131+
Open a [GitHub issue](https://github.com/TheStreamCode/github-copilot-cli-launcher/issues) for bugs and feature requests. For support details, see [SUPPORT.md](SUPPORT.md).
132+
133+
## License
134+
135+
Released under the [MIT License](LICENSE).

‎SUPPORT.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Support
2+
3+
## Reporting Issues
4+
5+
Open a GitHub issue for bugs and feature requests:
6+
7+
- [GitHub Issues](https://github.com/TheStreamCode/vscode-copilot-cli-launcher/issues)
8+
9+
When reporting a bug, please include:
10+
11+
- VS Code version
12+
- Operating system and version
13+
- Extension version
14+
- Steps to reproduce the issue
15+
16+
## Contact
17+
18+
For direct support enquiries, contact [info@mikesoft.it](mailto:info@mikesoft.it) or visit [https://mikesoft.it](https://mikesoft.it).

‎docs/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Documentation
2+
3+
This directory contains engineering documents for the repository. End-user installation, usage, and troubleshooting guidance lives in the root `README.md`.
4+
5+
## Structure
6+
7+
- `specs/`: scoped design documents for engineering changes
8+
- `plans/`: implementation plans and historical execution notes
9+
10+
Current release focuses on one-click GitHub Copilot CLI launch from the editor toolbar and install detection for both the `gh` binary and the `gh-copilot` extension.
11+
12+
## Document Status
13+
14+
Files in `docs/` capture design and implementation decisions at a specific point in time. They may describe historical context, while the root documentation reflects the current product behavior.

‎media/icon.png‎

165 KB
Loading

‎media/launcher-mark.svg‎

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)