automation code generation from text instructions
Project description
🏄♀️ What is LaVague?
LaVague is an open-source Large Action Model framework for turning natural language into browser actions.
At LaVague's core, we have an Action Engine which uses advanced AI techniques (RAG, Few-shot learning, Chain of Thought) to “compile” natural language instructions into browser automation code, by leveraging Selenium or Playwright.
LaVague in Action
Here's an example of LaVague being used to execute natural language instructions on a browser to automate web interactions. This example uses the Gradio interface available with the lavague launch
CLI command:
🚀 Getting Started
Running LaVague in your local env
You can get started with LaVague
in 2 steps:
- Install LaVague & dependencies
wget https://raw.githubusercontent.com/lavague-ai/LaVague/main/setup.sh &&
sudo bash setup.sh
- Run your LaVague command!
You can either launch
an interactive Gradio interface, where you will see both the automation code generated for each instruction but also a live preview of the results of executing the code with a debug tab.
lavague --instructions examples/instructions/huggingface.yaml --config examples/configurations/api/openai_api.py launch
Or you can use the build
command to directly get the Python code leveraging Selenium in a file, which you can then inspect & execute locally.
lavague --instructions examples/instructions/huggingface.yaml --config examples/configurations/api/openai_api.py build
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.
🎭 Playwright integration
If you want to get started with LaVague build using Playwright as your underlying automation tool, see our Playwright integration guide
🙋 Contributing
We would love your help and support on our quest to build a robust and reliable Large Action Model for web automation.
To avoid having multiple people working on the same things & being unable to merge your work, we have outlined the following contribution process:
- 📢 We outline tasks on our
backlog
: we recommend you check out issues with thehelp-wanted
labels &good first issue
labels - 🙋♀️ If you are interested in working on one of these tasks, comment on the issue!
- 🤝 We will discuss with you and assign you the task with a
community assigned
label - 💬 We will then be available to discuss this task with you
- ⬆️ You should submit your work as a PR
- ✅ 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
Note, 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)!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.