Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 4.14 KB

README.md

File metadata and controls

101 lines (68 loc) · 4.14 KB
Raw

FilePursuit CLI

Use filepursuit to interact with FilePursuit API in the command line to Download, Open or Stream any file.

MIT Licence Open Source Love JavaScript Style Guide JavaScript Style Guide NPM
Buy Me A Coffee

Demo

asciicast

Table of Contents

Install

NPM

npm install -g filepursuit-cli

Yarn

yarn global add filepursuit-cli

Usage

After installing, use below steps to start using the CLI app:

  1. Get your free API key from rapidapi.com/azharxes/api/filepursuit
  2. After you have your own API key use it to configure filepursuit-cli in terminal by executing filepursuit config
  3. Start using the CLI app, type filepursuit in the terminal and execute it. Explore FilePursuit the fun way!! 🚀🚀
    Usage:
        filepursuit
        filepursuit [options]/[command]

    Displays help information.

    Options:

        -v, --version                       output the version number
        -h, --help                          output usage information

    Commands:
        - config                             set/reset FilePursuit api key
        - discover                          discover random indexed folder links and domain links

    Examples:

    $ filepursuit
    $ filepursuit config
    $ filepursuit discover
    $ filepursuit --version
    $ filepursuit -h

Contribute

Thanks for taking the time to contribute, Feel free to add features, fix or tinker things here!!

Reporting Issues

Found a problem? Want a new feature? First of all, see if your issue or idea has already been reported. If don't, just open a new clear and descriptive issue.

Submitting pull requests

Pull requests are the greatest contributions, so be sure they are focused in scope and do avoid unrelated commits.

  • Fork it!
  • Clone your fork: git clone https://github.com/<your-username>/filepursuit-cli
  • Navigate to the newly cloned directory: cd filepursuit-cli
  • Create a new branch for the new feature: git checkout -b my-new-feature
  • Install the tools necessary for development: yarn
  • Make your changes.
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request with full remarks documenting your changes

License

MIT License © Shashank Shekhar

Disclaimer:

This unofficial FilePursuit CLI app is not affiliated with or endorsed by FilePursuit. It is intended for personal and educational use only. Users are responsible for their actions, ensuring compliance with copyright laws. The developers assume no liability for usage or unauthorized activities. The app is provided as-is, without warranties. Use responsibly, respect intellectual property rights, and support official services. Note that unofficial apps may carry risks, so exercise caution. We do not claim ownership of FilePursuit. For inquiries or issues, contact the official FilePursuit team. Thank you for understanding and using the app responsibly.