https://github.com/rgrannell1/peruse
Scroll through webpages automatically 👀
https://github.com/rgrannell1/peruse
cli scroll website
Last synced: 23 days ago
JSON representation
Scroll through webpages automatically 👀
- Host: GitHub
- URL: https://github.com/rgrannell1/peruse
- Owner: rgrannell1
- Created: 2020-11-25T18:45:35.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-30T09:21:11.000Z (over 5 years ago)
- Last Synced: 2025-10-28T05:53:43.678Z (9 months ago)
- Topics: cli, scroll, website
- Language: TypeScript
- Homepage:
- Size: 50.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# peruse 👀
Scroll through webpages automatically. This is useful for browsing through operations dashboards.
### Usage
```
peruse --links [--rate | --fast | --medium | --slow] [--executable ]
```
Create a file containing all links you wish to load. If this file is executable, stdout is intercepted upon running this file.
```
https://www.lipsum.com/
https://www.gutenberg.org/
```
then run
```sh
peruse --links links.txt
```
to open a Puppeteer window that scrolls through site alternatively.
#### Shortcuts
Peruse binds the following shortcuts to each target page:
- 1: set speed to slow
- 2: set speed to medium
- 3: set speed to fast
- `Space`: pause / unpause
### Tests
Tests that:
- scrolling stops / starts in the correct locations
- the page title dynamically updates
- pause and unpause works
- each speed scrolls at the expected rate
### Stability Index
1, Experimental - This project might die, it's undertested and underdocumented, and redesigns and breaking changes are likely
### License
The MIT License
Copyright (c) 2020 Róisín Grannell
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.