Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #55

Merged
merged 1 commit into from
Sep 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,32 @@ First, make sure that you have `poetry`
then install the github resolver package:

```bash
git clone github.com/All-Hands-AI/github-resolver
cd github-resolver
poetry install
```

If you don't have one already, create a github
[fine-grained personal access token](https://github.com/settings/tokens)
If you don't have one already, create a GitHub access token. You can use
[this link](https://github.com/settings/tokens/new?description=openhands-issue-resolver&scopes=repo)
to quickly generate a classic access token. Or, for additional security, you can
[create a fine-grained token](https://github.com/settings/personal-access-tokens/new)
that has "Content" and "Pull requests" scopes for the repository you
want to resolve issues in. If you don't have push access to that repo,
you can create a fork of the repo and use the fork. Then set the `GITHUB_TOKEN`
environment variable to your fine-grained personal access token.
you can create a fork of the repo and use the fork.

Once you have your token set the `GITHUB_TOKEN` environment variable, e.g.
```bash
export GITHUB_TOKEN="your-secret-token"
```

You'll also need to have choose an `LLM_MODEL` and prepare an `LLM_API_KEY`,
for which you can follow the OpenHands setup instructions.
for which you can follow the OpenHands setup instructions. OpenHands works
best with large, popular models like OpenAI's gpt-4o and Anthropic's Claude.

```bash
export LLM_MODEL="anthropic/claude-3-5-sonnet-20240620"
export LLM_API_KEY="sk_test_12345"
```

## Running the agent to resolve issues

Expand Down