Files
providers/.docs/content/3.Developer/0.dev-cli.md
2023-10-03 23:02:53 +01:00

1.9 KiB

Testing Providers

In order to test providers effectively, a built-in tool can be used which allows testing of individual source and embed providers.

There are two ways to use the tool:

  • Command Line Mode - For passing in arguments directly to the script. This is useful in non-interactive environments such as CI or to repeatedly test during development.
  • Question Mode - Where the script asks you questions about which source you wish to test.

::code-group

npm run test:dev
npm run test:dev -- [options]

# Example testing FlixHQ with "Spirited Away"
npm run test:dev -- -sid flixhq -tid 129 -t movie

::

The following Command Line 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