movie-web/providers
1
0
Fork 0
mirror of https://github.com/movie-web/providers.git synced 2025-09-13 09:33:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
mrjvs
2023-12-29 17:24:34 +01:00
parent 17662b01b9
commit 829d87cdd5
1 changed files with 2 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -9,27 +9,6 @@ features:
Visit documentation here: https://providers.docs.movie-web.app/
## Development
To make testing scrapers easier during development a CLI tool is available to run specific sources. To run the CLI testing tool, use `npm run cli`. The script supports 2 execution modes
## How to run locally or test my changes
- CLI Mode, for passing in arguments directly to the script
- Question Mode, where the script asks you questions about which source you wish to test
The following CLI Mode arguments are available
| Argument | Alias | Description | Default |
|---------------|--------|-------------------------------------------------------------------------|--------------|
| `--fetcher` | `-f` | Fetcher type. Either `node-fetch` or `native` | `node-fetch` |
| `--source-id` | `-sid` | Source ID for the source to be tested | |
| `--tmdb-id` | `-tid` | TMDB ID for the media to scrape. Only used if source is a provider | |
| `--type` | `-t` | Media type. Either `movie` or `show`. Only used if source is a provider | `movie` |
| `--season` | `-s` | Season number. Only used if type is `show` | `0` |
| `--episode` | `-e` | Episode number. Only used if type is `show` | `0` |
| `--url` | `-u` | URL to a video embed. Only used if source is an embed | |
| `--help` | `-h` | Shows help for the command arguments | |
Example testing the FlixHQ source on the movie "Spirited Away"
```bash
npm run cli -- -sid flixhq -tid 129 -t movie
```
These topics are also covered in the documentation, [read about it here](https://providers.docs.movie-web.app/extra-topics/development).