github-brain 1.8.0 → 1.10.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 +13 -59
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -31,19 +31,17 @@ Or use `npx github-brain` to run without installing globally.
31
31
  ## Usage
32
32
 
33
33
  ```sh
34
- github-brain <command> [<args>]
34
+ github-brain
35
35
  ```
36
36
 
37
- **Workflow:**
37
+ Launches the interactive TUI where you can:
38
38
 
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
39
+ 1. **Login** - Authenticate with GitHub
40
+ 2. **Pull** - Populate the local database with GitHub data
42
41
 
43
- Re-run `pull` anytime to update the database with new GitHub data.
42
+ Re-run pull anytime to update the database with new GitHub data.
44
43
 
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.
44
+ The app loads environment variables from a `.env` file in the GitHub Brain's home directory - `~/.github-brain` by default.
47
45
 
48
46
  <details>
49
47
  <summary>Example .env file</summary>
@@ -53,42 +51,10 @@ You can change the home directory with the `-m` argument available for all comma
53
51
 
54
52
  </details>
55
53
 
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
54
  | Argument | Description |
68
55
  | :------- | :----------------------------------------- |
69
56
  | `-m` | Home directory. Default: `~/.github-brain` |
70
57
 
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
58
  <details>
93
59
  <summary>Personal access token scopes</summary>
94
60
 
@@ -100,30 +66,18 @@ The first run may take a while. Subsequent runs are faster, fetching only new da
100
66
 
101
67
  </details>
102
68
 
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
69
+ ## MCP Server
119
70
 
120
- **Version:**
71
+ Start the MCP server using the local database:
121
72
 
122
73
  ```sh
123
- github-brain --version
74
+ github-brain mcp
124
75
  ```
125
76
 
126
- Displays the current version (commit hash and build date).
77
+ | Argument | Variable | Description |
78
+ | :------- | :------------- | :----------------------------------------- |
79
+ | `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
80
+ | `-m` | | Home directory. Default: `~/.github-brain` |
127
81
 
128
82
  ## MCP Configuration
129
83
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "github-brain",
3
- "version": "1.8.0",
3
+ "version": "1.10.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.8.0",
27
- "github-brain-darwin-x64": "1.8.0",
28
- "github-brain-linux-arm64": "1.8.0",
29
- "github-brain-linux-x64": "1.8.0",
30
- "github-brain-windows": "1.8.0"
26
+ "github-brain-darwin-arm64": "1.10.0",
27
+ "github-brain-darwin-x64": "1.10.0",
28
+ "github-brain-linux-arm64": "1.10.0",
29
+ "github-brain-linux-x64": "1.10.0",
30
+ "github-brain-windows": "1.10.0"
31
31
  },
32
32
  "files": [
33
33
  "bin",