Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deptagency/octopus
Recursive and multi-threaded broken link checker
https://github.com/deptagency/octopus
broken checker crawler links
Last synced: 2 months ago
JSON representation
Recursive and multi-threaded broken link checker
- Host: GitHub
- URL: https://github.com/deptagency/octopus
- Owner: deptagency
- License: mit
- Created: 2019-01-14T14:27:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-17T13:26:59.000Z (almost 3 years ago)
- Last Synced: 2024-11-01T15:48:02.882Z (3 months ago)
- Topics: broken, checker, crawler, links
- Language: JavaScript
- Size: 25.4 KB
- Stars: 33
- Watchers: 5
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Octopus
Quickly crawl a whole website for broken links
### Install
```bash
npm install --global @deptagency/octopus
```
*or*
```bash
yarn global add @deptagency/octopus
```
### Usage
```bash
octopus [options]
```
### Options
Option | Description | Default
------ | ----------- | -------
`--ignore-query` | Ignore a query string | `false`
`--ignore-external` | Ignore all external links | `false`
`--ignore-nofollow` | Ignore `rel=nofollow` links | `false`
`--include-images` | Check `![]()
` elements | `false`
`--slack-webhook` | Slack incoming webhook url | `none`
`--timeout` | Time to wait for response | `5000`
`--silent` | Run without printing progress line | `false`
`--help` | Output help text |
### Examples
```bash
octopus www.deptagency.com
octopus www.awg-mode.de --ignore-external
octopus www.hardeck.de --ignore-query=isEnergyEfficiencyChartOpen --ignore-query=followSearch
octopus www.golfino.com --silent --slack-webhook=https://hooks.slack.com/services/XXX/XXX/XXX
```
### Icon
Made by [Freepik](https://www.freepik.com) from [www.flaticon.com](https://www.flaticon.com)