KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

rize

★ 176 Open GitHub ↗

High-level, fluent and chainable API provided library for puppeteer.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Rize is a high-level, fluent and chainable API provided library which let you use puppeteer simply.

"Rize" is pronounced like /ɾize/, not /raɪzɪ/. "Rize" is one of characters in [*Is the Order a Rabbit?*](https://en.wikipedia.org/wiki/Is_the_Order_a_Rabbit%3F).

### Translations

[简体中文](https://rize.js.org/zh-CN/)

We need your help to translate the docs!

## Installation

You should install `puppeteer` at the same time.

```bash
yarn add --dev puppeteer rize
```

or via npm:

```bash
npm install --save-dev puppeteer rize
```

If you are in China, you may specify Chromium binary mirror.

On Linux or macOS:

```bash
PUPPETEER_DOWNLOAD_HOST=https://npm.taobao.org/mirrors yarn add --dev puppeteer rize
```

On Windows:

```shell
SET PUPPETEER_DOWNLOAD_HOST=https://npm.taobao.org/mirrors yarn add --dev puppeteer rize
```

## Basic Usage

### Import

It's recommended to use ES-style import:

```javascript
import Rize from 'rize'
```

Or using CommonJS-style import, if you don't use any build tools:

```javascript
const Rize = require('rize')
```

### Getting Started

Just like this:

```javascript
const rize = new Rize()
```

You can pass some options to the constructor,
and these options are `puppeteer`'s options:

```javascript
const rize = new Rize({ headless: false })
```

All `Rize`'s APIs are chainable, so you can do something like this:

```javascript
const rize = new Rize()
rize
  .goto('https://github.com/')
  .type('input.header-search-input', 'node')
  .press('Enter')
  .waitForNavigation()
  .assertSee('Node.js')
  .end()  // Don't forget to call `end` function to exit browser!
```

All available APIs are listed [here](https://rize.js.org/api/classes/_index_.rize.html).

## Documentation

Please visit [rize.js.org](https://rize.js.org)

## Contribution

Before you contribute to Rize, please read [Contributing Guide](./.github/CONTRIBUTING.md).

## License

MIT License

rize

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README