automa Documentation

A browser extension for automating your browser by connecting blocks

RAW Doc

1. Project Overview & Quickstart (AutomaApp/automa)

Automa

An extension for automating your browser by connecting blocks.
Auto-fill forms, do a repetitive task, take a screenshot, or scrape website data โ€” the choice is yours. You can even schedule when the automation will execute!

Downloads

Marketplace

Browse the Automa marketplace where you can share and download workflows with others. Go to the marketplace »

Automa Chrome Extension Builder

Automa Chrome Extension Builder (Automa CEB for short) allows you to generate a standalone chrome extension based on Automa workflows. Go to the documentation »

Project setup

Before running the yarn dev or yarn build script, you need to create the getPassKey.js file in the src/utils directory. Inside the file write

js
export default function() {
  return 'anything-you-want';
}
bash
# Install dependencies
pnpm install

# Compiles and hot-reloads for development for the chrome browser
pnpm dev

# Compiles and minifies for production for the chrome browser
pnpm build

# Create a zip file from the build folder
pnpm build:zip

# Compiles and hot-reloads for development for the firefox browser
pnpm dev:firefox

# Compiles and minifies for production for the firefox browser
pnpm build:firefox

# Lints and fixes files
pnpm lint

Icon Preview

v-remixicon/icons: https://preview-v-remixicon.vercel.app/

Install Locally

Chrome

  1. Open chrome and navigate to extensions page using this URL: chrome://extensions.
  2. Enable the "Developer mode".
  3. Click "Load unpacked extension" button, browse the automa/build directory and select it.

Firefox

  1. Open firefox and navigate to about:debugging#/runtime/this-firefox.
  2. Click the "Load Temporary Add-on" button.
  3. Browse the automa/build directory and select the manifest.json file.

Contributors

Thanks to everyone who has submitted issues, made suggestions, and generally helped make this a better project.

License

Source code in this repository is variously licensed under the GNU Affero General Public License (AGPL), or the Automa Commercial License.

See LICENSE.txt for details.

2. Official Technical Reference & Guides (AutomaApp/automa-docs)

File: README.md

Automa Documentation

๐Ÿ“ Documentation for the automa chrome extension.

Building the Documentation

Install git if you don't already have it, and check out the documentation repo as follows,

bash
$ git clone https://github.com/AutomaApp/documentation.git
$ cd documentation

Developing

bash
$ yarn install
$ yarn dev # dev server at http://localhost:8080

File: docs/index.md


title: Getting started

Welcome

This is the documentation for Automa. Automa is a low-code/no-code browser extension for to do browser automation. Instead of manually typing, clicking, and retrieving data from a website, Automa will help you automate doing all that.

Installing Extension

Automa currently only supports Google Chrome And Firefox. And to install it, click one of the below buttons.

text
<a target="_blank" href="https://chrome.google.com/webstore/detail/automa/infppggnoaenmfagbfknfkancpbljcca">
  
  
</a>


<a target="_blank" href="https://addons.mozilla.org/en-US/firefox/addon/automa/">
  
  
</a>

Tutorials

For the Automa tutorials, you can go to the Tutorials section.