Skip to main content
The Github extension allows your agent to interact with Github repositories, issues, pull requests, and more, making it ideal for automating code-related tasks, managing projects, or gathering information from Github.

​
Setup

1

Get an API Key

To use the Github extension, you need to obtain an API key from Brave Search. You can get one by signing up at
2

Install the Web Search Extension

To install the Web Search extension, run the following command in your terminal:
ironclaw registry install github
3

Configure the API Key

After installing the extension, you need to configure your Github API key in IronClaw. You can do this by running:
ironclaw tool auth github
Then follow the prompts to enter your API key.
Be sure to create a fine-grained personal access token with only the necessary permissions for your use case. When in doubt, choose the least permissive options, you can always create new tokens with different permissions later on

​
Available Actions:

Here are some of the actions your agent can perform with the Github extension:
  • get_repo: Retrieve repository information
  • list_issues: List all issues in a repository
  • create_issue: Create a new issue
  • get_issue: Get details of a specific issue
  • list_pull_requests: List pull requests
  • get_pull_request: Get details of a specific pull request
  • get_pull_request_files: Get the list of files in a pull request
  • create_pr_review: Submit a pull request review
  • list_repos: List repositories (user/org)
  • get_file_content: Retrieve the content of a file in the repo
  • trigger_workflow: Manually trigger a GitHub Actions workflow
  • get_workflow_runs: List recent workflow runs

​
Working on Public Repositories

Lets configure our agent to have its own github account, which it can use to create issues and comment on PRs in public repositories.
1

Create a new Github account

Go to https://github.com and create a new account for your agent. If you are already logged in with your personal account you will need to briefly log out to create the new account, but you can log back in right after
2

Generate a Personal Access Token

On the agent’s Github account, go to Settings -> Developer settings -> Personal access tokens -> Tokens (classic) and generate a new token (classic) with the following permissions: repo -> public_repo
3

Authenticate the Github Extension

Now that you have the token, you can authenticate the Github extension by running:
ironclaw tool auth github
Then follow the prompts to enter the token you just generated.
4

Test it out!

Ask your agent to create a test issue in one of your public repositories, and check if the issue was created successfully.
Ask your agent to read the Github Markdown Guidelines and remember then when creating issues and comments, it can make the formatting much nicer!