github-brain 1.3.4 → 1.5.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.
Files changed (2) hide show
  1. package/README.md +32 -36
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -18,13 +18,7 @@ GitHub Brain complements (but does not replace) the [official GitHub MCP server]
18
18
 
19
19
  ![](./docs/pull.png)
20
20
 
21
- GitHub Brain also includes a web-based UI for ultra-fast search:
22
-
23
- ![](./docs/ui.png)
24
-
25
- And a Raycast extension:
26
-
27
-
21
+ GitHub Brain also includes a Raycast extension:
28
22
 
29
23
  ![](./docs/raycast.png)
30
24
 
@@ -46,8 +40,9 @@ github-brain <command> [<args>]
46
40
 
47
41
  **Workflow:**
48
42
 
49
- 1. Use `pull` to populate the local database
50
- 2. Use `mcp` to start the MCP server
43
+ 1. Use `login` to authenticate with GitHub (or set `GITHUB_TOKEN` manually)
44
+ 2. Use `pull` to populate the local database
45
+ 3. Use `mcp` to start the MCP server
51
46
 
52
47
  Re-run `pull` anytime to update the database with new GitHub data.
53
48
 
@@ -62,6 +57,21 @@ You can change the home directory with the `-m` argument available for all comma
62
57
 
63
58
  </details>
64
59
 
60
+ ### `login`
61
+
62
+ Opens your browser to authorize _GitHub Brain_ app and stores resulting `GITHUB_TOKEN` in the `.env` file.
63
+ Optionally, you can also specify `ORGANIZATION` to store in the same file.
64
+
65
+ Example:
66
+
67
+ ```sh
68
+ github-brain login
69
+ ```
70
+
71
+ | Argument | Description |
72
+ | :------- | :----------------------------------------- |
73
+ | `-m` | Home directory. Default: `~/.github-brain` |
74
+
65
75
  ### `pull`
66
76
 
67
77
  Populate the local database with GitHub data.
@@ -74,14 +84,14 @@ github-brain pull -o my-org
74
84
 
75
85
  The first run may take a while. Subsequent runs are faster, fetching only new data.
76
86
 
77
- | Argument | Variable | Description |
78
- | :------- | :---------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
79
- | `-t` | `GITHUB_TOKEN` | Your GitHub [personal token](https://github.com/settings/personal-access-tokens) to access the API. **Required.** |
80
- | `-o` | `ORGANIZATION` | The GitHub organization to pull data from. **Required.** |
81
- | `-m` | | Home directory. Default: `~/.github-brain` (or checkout directory if run via `scripts/run`). |
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. |
87
+ | Argument | Variable | Description |
88
+ | :------- | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------- |
89
+ | | `GITHUB_TOKEN` | Your GitHub token. Use `login` command or create a [personal token](https://github.com/settings/personal-access-tokens). **Required.** |
90
+ | `-o` | `ORGANIZATION` | The GitHub organization to pull data from. **Required.** |
91
+ | `-m` | | Home directory. Default: `~/.github-brain` |
92
+ | `-i` | | Pull only selected entities: `repositories`, `discussions`, `issues`, `pull-requests` (comma-separated). |
93
+ | `-f` | | Remove all data before pulling. With `-i`, removes only specified items. |
94
+ | `-e` | `EXCLUDED_REPOSITORIES` | Repositories to exclude (comma-separated). Useful for large repos not relevant to your analysis. |
85
95
 
86
96
  <details>
87
97
  <summary>Personal access token scopes</summary>
@@ -104,24 +114,10 @@ Example:
104
114
  github-brain mcp -o my-org
105
115
  ```
106
116
 
107
- | Argument | Variable | Description |
108
- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------- |
109
- | `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
110
- | `-m` | | Home directory. Default: `~/.github-brain` (or checkout directory if run via `scripts/run`). |
111
-
112
- ### `ui`
113
-
114
- Start the web UI for quick searches (alternative to MCP).
115
-
116
- ```sh
117
- github-brain ui -o my-org
118
- ```
119
-
120
- | Argument | Variable | Description |
121
- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------- |
122
- | `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
123
- | `-m` | | Home directory. Default: `~/.github-brain` (or checkout directory if run via `scripts/run`). |
124
- | `-p` | `UI_PORT` | Port. Default: `8080`. |
117
+ | Argument | Variable | Description |
118
+ | :------- | :------------- | :------------------------------------------ |
119
+ | `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
120
+ | `-m` | | Home directory. Default: `~/.github-brain` |
125
121
 
126
122
  ### Additional Arguments
127
123
 
@@ -183,4 +179,4 @@ The extension uses the MCP server to search GitHub data.
183
179
 
184
180
  ## Development
185
181
 
186
- `scripts/run` builds and runs `github-brain` with the checkout directory as home (database in `db/`, config in `.env`).
182
+ `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.4",
3
+ "version": "1.5.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.3.4",
27
- "github-brain-darwin-x64": "1.3.4",
28
- "github-brain-linux-arm64": "1.3.4",
29
- "github-brain-linux-x64": "1.3.4",
30
- "github-brain-windows": "1.3.4"
26
+ "github-brain-darwin-arm64": "1.5.0",
27
+ "github-brain-darwin-x64": "1.5.0",
28
+ "github-brain-linux-arm64": "1.5.0",
29
+ "github-brain-linux-x64": "1.5.0",
30
+ "github-brain-windows": "1.5.0"
31
31
  },
32
32
  "files": [
33
33
  "bin",