alenbadel/lavague

Text2Action AI to automate browser interaction

Welcome to LaVague

Copilot for devs to automate automation

🏄‍♀️ What is LaVague?

LaVague is an open-source project designed to automate automation for devs!

We use advanced AI techniques (RAG, Few-shot learning, Chain of Thought) to turn natural language instructions into Python code leveraging Selenium. LaVague is designed to make it easy for users to automate web workflows and execute them on a browser.

LaVague in Action

Here's an example to show how LaVague can execute natural language instructions on a browser to automate interactions with a website:

LaVague interacting with Hugging Face's website.

🚀 Getting Started

Running LaVague in your local env

You can get started with LaVague in 2 steps:

1. Install LaVague & dependencies

wget https://raw.githubusercontent.com/lavague-ai/LaVague/main/setup.sh &&
sudo bash setup.sh

2. Run your LaVague command!

You can either launch an interactive demo, where LaVague will execute and show you the results of the automation code it generates for your instruction.

lavague-launch --file_path tests/hf.txt --config_path examples/api/openai_api.py

Or you can use the lavague-build to directly get the Python code leveraging Selenium in a file, which you can then inspect & execute locally.

lavague-build --file_path tests/hf.txt --config_path examples/api/openai_api.py

For a step-by-step guide or to run LaVague in a Google Colab, see our quick-tour which will walk you through how to get set-up and launch LaVague with our CLI tool.

🙋 Contributing

We would love your help in making La Vague a reality.

To avoid having multiple people working on the same things & being unable to merge your work, we have outlined the following contribution process:

1. 📢 We outline tasks on our backlog: we recommend you check out issues with the help-wanted labels & good first issue labels
2. 🙋‍♀️ If you are interested in working on one of these tasks, comment on the issue!
3. 🤝 We will discuss with you and assign you the task with a community assigned label
4. 💬 We will then be available to discuss this task with you
5. ⬆️ You should submit your work as a PR
6. ✅ We will review & merge your code or request changes/give feedback

Please check out our contributing guide for a more detailed guide.

If you want to ask questions, contribute, or have proposals, please come on our Discord to chat!

🗺️ Roadmap

TO keep up to date with our project backlog here.

🚨 Disclaimer

This project executes LLM-generated code using exec. This is not considered a safe practice. We therefore recommend taking extra care when using LaVague (such as running LaVague in a sandboxed environment)!