github-brain 1.9.0 → 1.11.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 +23 -60
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -26,24 +26,31 @@ GitHub Brain is [programmed in Markdown](https://github.blog/ai-and-ml/generativ
26
26
  npm i -g github-brain
27
27
  ```
28
28
 
29
- Or use `npx github-brain` to run without installing globally.
29
+ Rerun to update. `sudo` may be required on some systems.
30
+
31
+ Alternatively use `npx` to run without installing globally and needing `sudo`.
32
+
33
+ ```sh
34
+ npx github-brain@latest
35
+ ```
30
36
 
31
37
  ## Usage
32
38
 
33
39
  ```sh
34
- github-brain <command> [<args>]
40
+ github-brain
35
41
  ```
36
42
 
37
- **Workflow:**
43
+ Launches the interactive TUI where you can:
38
44
 
39
- 1. Use `login` to authenticate with GitHub (or set `GITHUB_TOKEN` manually)
40
- 2. Use `pull` to populate the local database
41
- 3. Use `mcp` to start the MCP server
45
+ 1. **Setup** - Configure authentication and settings
46
+ - Login with GitHub (OAuth) - Recommended for most users
47
+ - Login with Personal Access Token - For fine-grained tokens or when OAuth is unavailable
48
+ - Open configuration file - Edit `.env` directly
49
+ 2. **Pull** - Populate the local database with GitHub data
42
50
 
43
- Re-run `pull` anytime to update the database with new GitHub data.
51
+ Re-run pull anytime to update the database with new GitHub data.
44
52
 
45
- Each command has its own arguments. Some can be set via environment variables. The app will also load environment variables from a `.env` file in the GitHub Brain's home directory - `~/.github-brain` by default.
46
- You can change the home directory with the `-m` argument available for all commands.
53
+ The app loads environment variables from a `.env` file in the GitHub Brain's home directory - `~/.github-brain` by default.
47
54
 
48
55
  <details>
49
56
  <summary>Example .env file</summary>
@@ -53,42 +60,10 @@ You can change the home directory with the `-m` argument available for all comma
53
60
 
54
61
  </details>
55
62
 
56
- ### `login`
57
-
58
- Opens your browser to authorize _GitHub Brain_ app and stores resulting `GITHUB_TOKEN` in the `.env` file.
59
- Optionally, you can also specify `ORGANIZATION` to store in the same file.
60
-
61
- Example:
62
-
63
- ```sh
64
- github-brain login
65
- ```
66
-
67
63
  | Argument | Description |
68
64
  | :------- | :----------------------------------------- |
69
65
  | `-m` | Home directory. Default: `~/.github-brain` |
70
66
 
71
- ### `pull`
72
-
73
- Populate the local database with GitHub data.
74
-
75
- Example:
76
-
77
- ```sh
78
- github-brain pull -o my-org
79
- ```
80
-
81
- The first run may take a while. Subsequent runs are faster, fetching only new data.
82
-
83
- | Argument | Variable | Description |
84
- | :------- | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------- |
85
- | | `GITHUB_TOKEN` | Your GitHub token. Use `login` command or create a [personal token](https://github.com/settings/personal-access-tokens). **Required.** |
86
- | `-o` | `ORGANIZATION` | The GitHub organization to pull data from. **Required.** |
87
- | `-m` | | Home directory. Default: `~/.github-brain` |
88
- | `-i` | | Pull only selected entities: `repositories`, `discussions`, `issues`, `pull-requests` (comma-separated). |
89
- | `-f` | | Remove all data before pulling. With `-i`, removes only specified items. |
90
- | `-e` | `EXCLUDED_REPOSITORIES` | Repositories to exclude (comma-separated). Useful for large repos not relevant to your analysis. |
91
-
92
67
  <details>
93
68
  <summary>Personal access token scopes</summary>
94
69
 
@@ -100,30 +75,18 @@ The first run may take a while. Subsequent runs are faster, fetching only new da
100
75
 
101
76
  </details>
102
77
 
103
- ### `mcp`
104
-
105
- Start the MCP server using the local database.
106
-
107
- Example:
108
-
109
- ```sh
110
- github-brain mcp -o my-org
111
- ```
112
-
113
- | Argument | Variable | Description |
114
- | :------- | :------------- | :------------------------------------------ |
115
- | `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
116
- | `-m` | | Home directory. Default: `~/.github-brain` |
117
-
118
- ### Additional Arguments
78
+ ## MCP Server
119
79
 
120
- **Version:**
80
+ Start the MCP server using the local database:
121
81
 
122
82
  ```sh
123
- github-brain --version
83
+ github-brain mcp
124
84
  ```
125
85
 
126
- Displays the current version (commit hash and build date).
86
+ | Argument | Variable | Description |
87
+ | :------- | :------------- | :----------------------------------------- |
88
+ | `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
89
+ | `-m` | | Home directory. Default: `~/.github-brain` |
127
90
 
128
91
  ## MCP Configuration
129
92
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "github-brain",
3
- "version": "1.9.0",
3
+ "version": "1.11.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.9.0",
27
- "github-brain-darwin-x64": "1.9.0",
28
- "github-brain-linux-arm64": "1.9.0",
29
- "github-brain-linux-x64": "1.9.0",
30
- "github-brain-windows": "1.9.0"
26
+ "github-brain-darwin-arm64": "1.11.0",
27
+ "github-brain-darwin-x64": "1.11.0",
28
+ "github-brain-linux-arm64": "1.11.0",
29
+ "github-brain-linux-x64": "1.11.0",
30
+ "github-brain-windows": "1.11.0"
31
31
  },
32
32
  "files": [
33
33
  "bin",