puppet

🎭 Puppet

Natural-language web automation using Puppeteer.

⭐️ How it works

Write in natural language (following the Commands section). For example, you can create a file with the following set of commands:

path/to/download.puppet:

Go to typeform.com
Click on the login link
Type username [e-mail]
Type password 3rjiw9qie2308
Click on login button
Take a screenshot
Download https://admin.typeform.com/export
Save to to report.csv

Then, run the command:

puppet "path/to/download.puppet"

💡 Usage

Install the package from npm:

npm install puppet

Install and use the CLI:

npm install --save-global puppet
puppet "path/to/commands.puppet"

Import and use the API:

const { puppet } = require("puppet"); // Node.js
import { puppet } from "puppet"; // TypeScript/ES6

const { url } = await puppet("path/to/commands.puppet");

🔫 Commands

Command example	Description
Go to example.com	Navigate to a URL
Wait for 5 seconds	Wait for a specific time
Click on learn more link	Perform event on DOM element
Wait for navigation	Wait for next page to load

👩‍💻 Development

Build TypeScript:

npm run build

Run unit tests and view coverage:

npm run test-without-reporting

Related work

• Puppeteer is the headless Chrome API for Node.js
• Archiver is the Internet Archive saver I made using Puppeteer
• TagUI is a CLI for digital process automation (RPA)

✨ Contributors

Thanks goes to these wonderful people (emoji key):

Anand Chowdhary 🤔 💻 ⚠️ 📖

Gajus Kuizinas 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!

📄 License

MIT © Anand Chowdhary