github-brain 1.3.4 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -22
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -24,8 +24,6 @@ GitHub Brain also includes a web-based UI for ultra-fast search:
|
|
|
24
24
|
|
|
25
25
|
And a Raycast extension:
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
29
27
|
|
|
30
28
|
|
|
31
29
|
GitHub Brain is [programmed in Markdown](https://github.blog/ai-and-ml/generative-ai/spec-driven-development-using-markdown-as-a-programming-language-when-building-with-ai/).
|
|
@@ -46,8 +44,9 @@ github-brain <command> [<args>]
|
|
|
46
44
|
|
|
47
45
|
**Workflow:**
|
|
48
46
|
|
|
49
|
-
1. Use `
|
|
50
|
-
2. Use `
|
|
47
|
+
1. Use `login` to authenticate with GitHub (or set `GITHUB_TOKEN` manually)
|
|
48
|
+
2. Use `pull` to populate the local database
|
|
49
|
+
3. Use `mcp` to start the MCP server
|
|
51
50
|
|
|
52
51
|
Re-run `pull` anytime to update the database with new GitHub data.
|
|
53
52
|
|
|
@@ -62,6 +61,21 @@ You can change the home directory with the `-m` argument available for all comma
|
|
|
62
61
|
|
|
63
62
|
</details>
|
|
64
63
|
|
|
64
|
+
### `login`
|
|
65
|
+
|
|
66
|
+
Opens your browser to authorize _GitHub Brain_ app and stores resulting `GITHUB_TOKEN` in the `.env` file.
|
|
67
|
+
Optionally, you can also specify `ORGANIZATION` to store in the same file.
|
|
68
|
+
|
|
69
|
+
Example:
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
github-brain login
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
| Argument | Description |
|
|
76
|
+
| :------- | :----------------------------------------- |
|
|
77
|
+
| `-m` | Home directory. Default: `~/.github-brain` |
|
|
78
|
+
|
|
65
79
|
### `pull`
|
|
66
80
|
|
|
67
81
|
Populate the local database with GitHub data.
|
|
@@ -74,14 +88,14 @@ github-brain pull -o my-org
|
|
|
74
88
|
|
|
75
89
|
The first run may take a while. Subsequent runs are faster, fetching only new data.
|
|
76
90
|
|
|
77
|
-
| Argument | Variable | Description
|
|
78
|
-
| :------- | :---------------------- |
|
|
79
|
-
|
|
|
80
|
-
| `-o` | `ORGANIZATION` | The GitHub organization to pull data from. **Required.**
|
|
81
|
-
| `-m` | | Home directory. Default: `~/.github-brain`
|
|
82
|
-
| `-i` | | Pull only selected entities: `repositories`, `discussions`, `issues`, `pull-requests` (comma-separated).
|
|
83
|
-
| `-f` | | Remove all data before pulling. With `-i`, removes only specified items.
|
|
84
|
-
| `-e` | `EXCLUDED_REPOSITORIES` | Repositories to exclude (comma-separated). Useful for large repos not relevant to your analysis.
|
|
91
|
+
| Argument | Variable | Description |
|
|
92
|
+
| :------- | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------- |
|
|
93
|
+
| | `GITHUB_TOKEN` | Your GitHub token. Use `login` command or create a [personal token](https://github.com/settings/personal-access-tokens). **Required.** |
|
|
94
|
+
| `-o` | `ORGANIZATION` | The GitHub organization to pull data from. **Required.** |
|
|
95
|
+
| `-m` | | Home directory. Default: `~/.github-brain` |
|
|
96
|
+
| `-i` | | Pull only selected entities: `repositories`, `discussions`, `issues`, `pull-requests` (comma-separated). |
|
|
97
|
+
| `-f` | | Remove all data before pulling. With `-i`, removes only specified items. |
|
|
98
|
+
| `-e` | `EXCLUDED_REPOSITORIES` | Repositories to exclude (comma-separated). Useful for large repos not relevant to your analysis. |
|
|
85
99
|
|
|
86
100
|
<details>
|
|
87
101
|
<summary>Personal access token scopes</summary>
|
|
@@ -104,10 +118,10 @@ Example:
|
|
|
104
118
|
github-brain mcp -o my-org
|
|
105
119
|
```
|
|
106
120
|
|
|
107
|
-
| Argument | Variable | Description
|
|
108
|
-
| :------- | :------------- |
|
|
109
|
-
| `-o` | `ORGANIZATION` | GitHub organization. **Required.**
|
|
110
|
-
| `-m` | | Home directory. Default: `~/.github-brain`
|
|
121
|
+
| Argument | Variable | Description |
|
|
122
|
+
| :------- | :------------- | :------------------------------------------ |
|
|
123
|
+
| `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
|
|
124
|
+
| `-m` | | Home directory. Default: `~/.github-brain` |
|
|
111
125
|
|
|
112
126
|
### `ui`
|
|
113
127
|
|
|
@@ -117,11 +131,11 @@ Start the web UI for quick searches (alternative to MCP).
|
|
|
117
131
|
github-brain ui -o my-org
|
|
118
132
|
```
|
|
119
133
|
|
|
120
|
-
| Argument | Variable | Description
|
|
121
|
-
| :------- | :------------- |
|
|
122
|
-
| `-o` | `ORGANIZATION` | GitHub organization. **Required.**
|
|
123
|
-
| `-m` | | Home directory. Default: `~/.github-brain`
|
|
124
|
-
| `-p` | `UI_PORT` | Port. Default: `8080`.
|
|
134
|
+
| Argument | Variable | Description |
|
|
135
|
+
| :------- | :------------- | :------------------------------------------|
|
|
136
|
+
| `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
|
|
137
|
+
| `-m` | | Home directory. Default: `~/.github-brain` |
|
|
138
|
+
| `-p` | `UI_PORT` | Port. Default: `8080`. |
|
|
125
139
|
|
|
126
140
|
### Additional Arguments
|
|
127
141
|
|
|
@@ -183,4 +197,4 @@ The extension uses the MCP server to search GitHub data.
|
|
|
183
197
|
|
|
184
198
|
## Development
|
|
185
199
|
|
|
186
|
-
`scripts/run` builds and runs `github-brain` with the checkout directory as home (database in `db/`, config in `.env`).
|
|
200
|
+
`scripts/run` builds and runs `github-brain` with the checkout directory as home `-m` (database in `db/`, config in `.env`).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "github-brain",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "MCP server for searching GitHub discussions, issues, and pull requests",
|
|
5
5
|
"bin": {
|
|
6
6
|
"github-brain": "bin/github-brain.js"
|
|
@@ -23,11 +23,11 @@
|
|
|
23
23
|
"author": "wham",
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"optionalDependencies": {
|
|
26
|
-
"github-brain-darwin-arm64": "1.
|
|
27
|
-
"github-brain-darwin-x64": "1.
|
|
28
|
-
"github-brain-linux-arm64": "1.
|
|
29
|
-
"github-brain-linux-x64": "1.
|
|
30
|
-
"github-brain-windows": "1.
|
|
26
|
+
"github-brain-darwin-arm64": "1.4.0",
|
|
27
|
+
"github-brain-darwin-x64": "1.4.0",
|
|
28
|
+
"github-brain-linux-arm64": "1.4.0",
|
|
29
|
+
"github-brain-linux-x64": "1.4.0",
|
|
30
|
+
"github-brain-windows": "1.4.0"
|
|
31
31
|
},
|
|
32
32
|
"files": [
|
|
33
33
|
"bin",
|