Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m1guelpf/browser-agent
A browser AI agent, using GPT-4
https://github.com/m1guelpf/browser-agent
Last synced: 2 days ago
JSON representation
A browser AI agent, using GPT-4
- Host: GitHub
- URL: https://github.com/m1guelpf/browser-agent
- Owner: m1guelpf
- License: mit
- Created: 2023-03-22T08:49:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-25T22:03:06.000Z (over 1 year ago)
- Last Synced: 2024-05-21T02:24:37.251Z (6 months ago)
- Language: Rust
- Homepage: https://docs.rs/browser-agent
- Size: 70.3 KB
- Stars: 661
- Watchers: 8
- Forks: 61
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- stars - m1guelpf/browser-agent - A browser AI agent, using GPT-4 (Rust)
- awesome-llm-and-aigc - m1guelpf/browser-agent - agent?style=social"/> : A browser AI agent, using GPT-4. [docs.rs/browser-agent](https://docs.rs/browser-agent/latest/browser_agent/) (Applications / 提示语（魔法）)
- awesome-llm-and-aigc - m1guelpf/browser-agent - agent?style=social"/> : A browser AI agent, using GPT-4. [docs.rs/browser-agent](https://docs.rs/browser-agent/latest/browser_agent/) (Summary)
- awesome-cuda-and-hpc - m1guelpf/browser-agent - agent?style=social"/> : A browser AI agent, using GPT-4. [docs.rs/browser-agent](https://docs.rs/browser-agent/latest/browser_agent/) (Frameworks)
- awesome-cuda-and-hpc - m1guelpf/browser-agent - agent?style=social"/> : A browser AI agent, using GPT-4. [docs.rs/browser-agent](https://docs.rs/browser-agent/latest/browser_agent/) (Frameworks)
- awesome-rust-list - m1guelpf/browser-agent - agent?style=social"/> : A browser AI agent, using GPT-4. [docs.rs/browser-agent](https://docs.rs/browser-agent/latest/browser_agent/) (Machine Learning)
- awesome-rust-list - m1guelpf/browser-agent - agent?style=social"/> : A browser AI agent, using GPT-4. [docs.rs/browser-agent](https://docs.rs/browser-agent/latest/browser_agent/) (Machine Learning)
README
# A browser AI agent, using GPT-4
This project provides a bridge between GPT-4 and a headless Chromium browser, allowing you to automate actions simply by describing them to the program. It takes the form of a Rust CLI, but also exports most of the internals as a library for others to use.
## Installation
`browser-agent` is built using Rust, so you'll need to install the Rust toolchain. You can do this by following the instructions at [rustup.rs](https://rustup.rs/).
Once you have Rust installed, you can install `browser-agent` by running:
```bash
cargo install browser-agent
```
You should also place your OpenAI API key in the `OPENAI_API_KEY` environment variable. This key should have access to the `gpt-4` model.
You can copy the contents of the `example.env` file to a `.env` file in the root of the project, and fill in the `OPENAI_API_KEY` variable. The `.env` file is ignored by git, so you don't have to worry about accidentally committing your API key. Note though, `.env.example` is not ignored, so you should not change that file.
## Usage
```
Usage: browser-agent [OPTIONS]
Arguments:
The goal for the agent to achieve
Options:
--visual Whether to show the browser window. Warning: this makes the agent more unreliable
-v... Set the verbosity level, can be used multiple times
--include-page-content Whether to include text from the page in the prompt
-h, --help Print help
-V, --version Print version
```
## Aknowledgements
This project was inspired and builds on top of [Nat Friedman](https://github.com/nat)'s [natbot](https://github.com/nat/natbot) experiment.
## License
This project is licensed under the MIT license. See [LICENSE](LICENSE) for more details.