From b204e9d0cfdbad63d88d86500333fe1915e47349 Mon Sep 17 00:00:00 2001 From: MayorFaj Date: Sun, 6 Apr 2025 17:53:19 +0100 Subject: [PATCH 1/2] Add installation instructions for Homebrew and CLI usage in README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9330723c..a3082061 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,33 @@ automation and interaction capabilities for developers and tools. 2. [Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new). 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)). +## Installation +### Homebew (Mac) -## Installation +``` +brew install github-mcp-server +``` + +#### Using the CLI After Homebrew Installation + +After installing with Homebrew, you can run the server with: + +``` +# Set your GitHub token +export GITHUB_PERSONAL_ACCESS_TOKEN= +``` + +``` +# Run the server in stdio mode +github-mcp-server stdio +``` + +For more options and commands: + +``` +github-mcp-server --help +``` ### Usage with VS Code From 6576cf649c48a497a1f8f637d34450ede8b3ba06 Mon Sep 17 00:00:00 2001 From: MayorFaj <127399119+MayorFaj@users.noreply.github.com> Date: Sun, 6 Apr 2025 18:17:36 +0100 Subject: [PATCH 2/2] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index a3082061..6364ded9 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,7 @@ The MCP server can use many of the GitHub APIs, so enable the permissions that y ## Installation -### Homebew (Mac) - +### Homebrew (Mac) ``` brew install github-mcp-server ```