{"id":19686127,"url":"https://github.com/loiccoyle/prowlet","last_synced_at":"2025-05-07T00:21:56.538Z","repository":{"id":116544848,"uuid":"583057610","full_name":"loiccoyle/prowlet","owner":"loiccoyle","description":"🔎 Query the Prowlarr search API from the command line","archived":false,"fork":false,"pushed_at":"2023-09-18T23:05:10.000Z","size":22,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T04:26:13.488Z","etag":null,"topics":["cli","prowlarr","scripting","search","shell","shell-script","torrent"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/loiccoyle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-28T16:28:48.000Z","updated_at":"2023-12-30T13:01:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"d2c912f8-5d16-4b3d-aa9e-2b7709c4aab6","html_url":"https://github.com/loiccoyle/prowlet","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Fprowlet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Fprowlet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Fprowlet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Fprowlet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loiccoyle","download_url":"https://codeload.github.com/loiccoyle/prowlet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252789146,"owners_count":21804400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","prowlarr","scripting","search","shell","shell-script","torrent"],"created_at":"2024-11-11T18:26:16.004Z","updated_at":"2025-05-07T00:21:56.507Z","avatar_url":"https://github.com/loiccoyle.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# prowlet\n\n\u003ca href=\"./LICENSE.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://aur.archlinux.org/packages/prowlet-git/\"\u003e\u003cimg src=\"https://img.shields.io/aur/version/prowlet-git\"\u003e\u003c/a\u003e\n\nQuery the [Prowlarr](https://github.com/prowlarr/prowlarr) search API from the command line.\n\n**Prefer a UI? Check out [`rofi-prowlet`](https://github.com/loiccoyle/rofi-prowlet)**\n\n## 📦 Installation\n\n### Dependencies\n\nIf you are installing manually, you'll need to also install the following dependencies:\n\n- [`curl`](https://github.com/curl/curl)\n- [`jq`](https://github.com/stedolan/jq)\n- Access to a [`prowlarr`](https://github.com/prowlarr/prowlarr) server.\n\n### Manual\n\nTo manually install `prowlet` just git clone this repository and place the script in your `$PATH`:\n\n```\ngit clone https://github.com/loiccoyle/prowlet\ncd prowlet\ncp prowlet /somewhere/in/your/PATH/\n```\n\nIf you want \u003cTAB\u003e completion, place the corresponding [`completion`](completions) file somewhere your shell knows about.\n\n### Arch linux\n\nUsing your prefered AUR helper:\n\n```\nparu -S prowlet-git\n```\n\n### Completions\n\nCompletions for various shells can be found in the [`completions`](completions) folder.\n\n## 📋 Usage\n\n\u003c!-- help start --\u003e\n\n```\n$ prowlet -h\nQuery the Prowlarr search API from the command line.\n\nUsage:\n    prowlet [OPTIONS] {search, config, indexers, categories, open}\n        -h                        Show this message and exit.\n        -r                        Raw output, no coloring.\n        -v                        Verbosisty, up to -vv.\n        -s                        Start prowlarr.service if not running.\n        -k                        Stop prowlarr.service before exiting.\n        -u PROWLARR_URL           Prowlarr URL.\n        -a API_KEY                Prowlarr API key, will query prowlarr if not provided.\n    prowlet search [OPTIONS] QUERY   Perform a search.\n        -f FORMAT                 Output format, in jq syntax, full json output if not provided.\n        -c CATEGORY               Restrict search to caregories.\n        -i INDEXER                Restrict search to indexers.\n                                  INDEXER must be a configured indexer.\n        -s SORTKEY                Sort results by key.\n    prowlet indexers             List configured indexers.\n    prowlet categories           List torrent categories.\n    prowlet config               Show prowlarr config (json).\n    prowlet open                 Open the prowlarr dashboard using 'xdg-open'.\n\nExamples:\n    Search for big buck bunny on all configured indexers.\n    $ prowlet search big buck bunny\n    Search for big buck bunny movies/tv on tpb indexer.\n    $ prowlet search -c movies -c tv -i thepiratebay big buck bunny\n    Search for ubuntu sorted by seeders.\n    $ prowlet search -s seeders ubuntu\n    Search for ubuntu and output the title and link, format with column.\n    $ prowlet search -f '\\(.title)|\\(.guid//.magnetUrl)' ubuntu | column -t -s\"|\"\n```\n\n\u003c!-- help end --\u003e\n\n## ✏️ Note\n\nTo use the `-s` and `-k` options to start and stop the `prowlarr` service before/after making a query, will require `sudo` access.\n\n## TODO\n\n- [x] AUR package\n- [ ] write bash completion\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floiccoyle%2Fprowlet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floiccoyle%2Fprowlet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floiccoyle%2Fprowlet/lists"}