# auto-browser

> Light abstraction onto puppeteer in order to simplify easy browser automation task

Latest version **1.0.3** (published 2021-12-21) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install auto-browser
pnpm add auto-browser
yarn add auto-browser
bun add auto-browser
```

Provides the command `auto-browser`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-12-21 |
| First published | 2020-02-11 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.3.0 |
| Dependencies | 7 |
| Unpacked size | 66.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tim Bernhard @GenieTim |
| Maintainers | bernhard_webstudio |
| Keywords | automation, browser, puppeteer |

## Links

- npm: https://www.npmjs.com/package/auto-browser
- Repository: https://github.com/GenieTim/auto-browser
- Issues: https://github.com/GenieTim/auto-browser/issues
- npm.io page: https://npm.io/package/auto-browser

## Dependencies (7)

- [glob](https://npm.io/package/glob.md) ^7.2.0
- [cli-ux](https://npm.io/package/cli-ux.md) ^6.0.6
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^13.0.0
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.18.2
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.8.16
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5.1.10

## Alternatives

- [@snazzah/davey](https://npm.io/package/@snazzah/davey.md) — 1.5M weekly downloads
- [@vendure/testing](https://npm.io/package/@vendure/testing.md) — 8.3K weekly downloads
- [vue-simple-context-menu](https://npm.io/package/vue-simple-context-menu.md) — 6.6K weekly downloads
- [cypress-webpack-preprocessor-v5](https://npm.io/package/cypress-webpack-preprocessor-v5.md) — 2.1K weekly downloads
- [@backstage/plugin-catalog-backend-module-puppetdb](https://npm.io/package/@backstage/plugin-catalog-backend-module-puppetdb.md) — 1.3K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-12-21
- 1.0.2 — 2021-12-20
- 1.0.1 — 2020-02-11
- 1.0.0 — 2020-02-11

## README

auto-browser
============

Light abstraction onto puppeteer in order to simplify easy browser automation tasks.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/auto-browser.svg)](https://npmjs.org/package/auto-browser)
[![Downloads/week](https://img.shields.io/npm/dw/auto-browser.svg)](https://npmjs.org/package/auto-browser)
[![License](https://img.shields.io/npm/l/auto-browser.svg)](https://github.com/GenieTim/auto-browser/blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
Example usage includes automatic participation in christmas/advent competitions 
so you do not have to do it manually, 24 times.

<!-- usage -->
```sh-session
$ npm install -g auto-browser
$ auto-browser COMMAND
running command...
$ auto-browser (-v|--version|version)
auto-browser/1.0.3 darwin-x64 node-v17.2.0
$ auto-browser --help [COMMAND]
USAGE
  $ auto-browser COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`auto-browser browse [WEBPAGE]`](#auto-browser-browse-webpage)
* [`auto-browser generate`](#auto-browser-generate)
* [`auto-browser help [COMMAND]`](#auto-browser-help-command)
* [`auto-browser list`](#auto-browser-list)

## `auto-browser browse [WEBPAGE]`

Start browsing the configured page(s)

```
USAGE
  $ auto-browser browse [WEBPAGE]

ARGUMENTS
  WEBPAGE  (www.games.ch.json|www.grandcasino-bern.ch.json|www.houseofbeer.ch.json|www.kalendoo.com.json|xmas.toppreise.
           ch.json|zattoo-adventskalender.com.json|zzz_adventcalendar.myswitzerland.com.json) The page to browse

OPTIONS
  -c, --confirmNext  confirm next: require user (CI) interaction before moving to next page
  -d, --debug        debug: get additional logs, show browser (disable headless)

DESCRIPTION
  ...
```

_See code: [src/commands/browse.js](https://github.com/GenieTim/auto-browser/blob/v1.0.3/src/commands/browse.js)_

## `auto-browser generate`

Generate a new config for a webpage to browse - interactively

```
USAGE
  $ auto-browser generate

OPTIONS
  -d, --debug=debug  debug: write some more stuff

DESCRIPTION
  ...
```

_See code: [src/commands/generate.js](https://github.com/GenieTim/auto-browser/blob/v1.0.3/src/commands/generate.js)_

## `auto-browser help [COMMAND]`

Display help for auto-browser.

```
USAGE
  $ auto-browser help [COMMAND]

ARGUMENTS
  COMMAND  Command to show help for.

OPTIONS
  -n, --nested-commands  Include all nested commands in the output.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_

## `auto-browser list`

List all available pages with their name/description

```
USAGE
  $ auto-browser list

OPTIONS
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

DESCRIPTION
  ...
```

_See code: [src/commands/list.js](https://github.com/GenieTim/auto-browser/blob/v1.0.3/src/commands/list.js)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/auto-browser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
