Skip to content

Commit 25ee2f7

Browse files
AddonoCopilot
andcommitted
docs: add LICENSE, demo recording, MCP config examples, fix repo URL
- Add MIT LICENSE file - Add SVG terminal recording showing CLI usage - Add Claude Desktop and VS Code MCP configuration examples - Add programmatic usage section to README - Fix repository URL to Addono/github-attach - Fix gh extension install URL Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent b40e026 commit 25ee2f7

4 files changed

Lines changed: 227 additions & 2 deletions

File tree

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) 2026 Addono
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: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
> Upload images to GitHub issues, PRs, and comments — from the CLI or via MCP.
77
8+
<p align="center">
9+
<img src="demo.svg" alt="gh-attach CLI demo" width="700">
10+
</p>
11+
812
GitHub doesn't provide an official API for attaching images to issues and pull requests. `gh-attach` fills this gap with multiple upload strategies, a clean CLI, and an MCP server for AI-powered workflows.
913

1014
## Features
@@ -22,7 +26,7 @@ GitHub doesn't provide an official API for attaching images to issues and pull r
2226
npm install -g gh-attach
2327

2428
# gh extension
25-
gh extension install owner/gh-attach
29+
gh extension install Addono/github-attach
2630
```
2731

2832
## Quick Start
@@ -74,6 +78,38 @@ gh-attach mcp --transport stdio
7478
gh-attach mcp --transport http --port 3000
7579
```
7680

81+
### Claude Desktop
82+
83+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
84+
85+
```json
86+
{
87+
"mcpServers": {
88+
"gh-attach": {
89+
"command": "gh-attach",
90+
"args": ["mcp", "--transport", "stdio"]
91+
}
92+
}
93+
}
94+
```
95+
96+
### VS Code
97+
98+
Add to `.vscode/settings.json`:
99+
100+
```json
101+
{
102+
"mcp": {
103+
"servers": {
104+
"gh-attach": {
105+
"command": "gh-attach",
106+
"args": ["mcp", "--transport", "stdio"]
107+
}
108+
}
109+
}
110+
}
111+
```
112+
77113
## Configuration
78114

79115
```bash
@@ -106,6 +142,19 @@ Config is stored at `~/.config/gh-attach/config.json` (overridable via `GH_ATTAC
106142
| `3` | Validation error (bad input) |
107143
| `4` | Network/upload error |
108144

145+
## Programmatic Usage
146+
147+
```typescript
148+
import { upload, selectStrategy } from "gh-attach";
149+
150+
const strategy = await selectStrategy({ token: process.env.GITHUB_TOKEN });
151+
const result = await strategy.upload({
152+
file: "./screenshot.png",
153+
target: { owner: "octocat", repo: "hello-world", issue: 42 },
154+
});
155+
console.log(result.url); // https://github.com/user-attachments/assets/...
156+
```
157+
109158
## Development
110159

111160
```bash

demo.svg

Lines changed: 155 additions & 0 deletions
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
"license": "MIT",
6767
"repository": {
6868
"type": "git",
69-
"url": "https://github.com/owner/gh-attach"
69+
"url": "https://github.com/Addono/github-attach"
7070
},
7171
"engines": {
7272
"node": ">=20"

0 commit comments

Comments
 (0)