You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Ensure `.env` files is configured to use the `github-brain-test` organization
22
+
- Use GitHub MCP to add new issue/PRs/discussions as needed for testing
23
+
- Simulate user input: Send key presses, control combinations, or specific commands to the running application.
24
+
- Capture and analyze screen output: The testing tool captures the terminal display (or buffer) at specific moments in time.
25
+
- Make assertions: Verify that the screen content matches the expected output (e.g., checking if specific text is present at certain coordinates or if the cursor position is correct).
Copy file name to clipboardExpand all lines: README.md
+13-59Lines changed: 13 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -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.
||`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`|
0 commit comments