Skip to content

Commit b204e9d

Browse files
committed
Add installation instructions for Homebrew and CLI usage in README.md
1 parent 6b02799 commit b204e9d

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,33 @@ automation and interaction capabilities for developers and tools.
1818
2. [Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).
1919
The MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).
2020

21+
## Installation
2122

23+
### Homebew (Mac)
2224

23-
## Installation
25+
```
26+
brew install github-mcp-server
27+
```
28+
29+
#### Using the CLI After Homebrew Installation
30+
31+
After installing with Homebrew, you can run the server with:
32+
33+
```
34+
# Set your GitHub token
35+
export GITHUB_PERSONAL_ACCESS_TOKEN=<github_token>
36+
```
37+
38+
```
39+
# Run the server in stdio mode
40+
github-mcp-server stdio
41+
```
42+
43+
For more options and commands:
44+
45+
```
46+
github-mcp-server --help
47+
```
2448

2549
### Usage with VS Code
2650

0 commit comments

Comments
 (0)