{"id":19686152,"url":"https://github.com/loiccoyle/cuff","last_synced_at":"2025-09-10T21:16:23.105Z","repository":{"id":116544650,"uuid":"358083029","full_name":"loiccoyle/cuff","owner":"loiccoyle","description":"🔎 Query the Jackett search API from the command line.","archived":false,"fork":false,"pushed_at":"2023-01-11T14:37:54.000Z","size":48,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T13:51:23.974Z","etag":null,"topics":["cli","cuff","jackett","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":"2021-04-15T00:51:23.000Z","updated_at":"2024-08-28T10:37:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"b38ae7ca-2ba6-4b8b-9860-c34683e9edb4","html_url":"https://github.com/loiccoyle/cuff","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%2Fcuff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Fcuff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Fcuff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Fcuff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loiccoyle","download_url":"https://codeload.github.com/loiccoyle/cuff/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251450656,"owners_count":21591407,"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","cuff","jackett","torrent"],"created_at":"2024-11-11T18:26:27.456Z","updated_at":"2025-04-29T06:31:19.590Z","avatar_url":"https://github.com/loiccoyle.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cuff\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/cuff-git/\"\u003e\u003cimg src=\"https://img.shields.io/aur/version/cuff-git\"\u003e\u003c/a\u003e\n\nQuery the [Jackett](https://github.com/jackett/jackett) search API from the command line.\n\n**Prefer a UI? Check out [`rofi-cuff`](https://github.com/loiccoyle/rofi-cuff)**\n\n**Do you use [`Prowlarr`](https://github.com/prowlarr/prowlarr) instead of `Jackett`? Check out [`prowlet`](https://github.com/loiccoyle/prowlet) / [`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 [`jackett`](https://github.com/jackett/jackett) server.\n\n### Manual\n\nTo manually install `cuff` just git clone this repository and place the script in your `$PATH`:\n\n```\ngit clone https://github.com/loiccoyle/cuff\ncd cuff\ncp cuff /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 cuff-git\n```\n\n# Completions\n\nCompletions for various shells can be found in the [`completions`](completions) folder.\n\n# Usage\n\n```\n$ cuff -h\nQuery the Jackett search API from the command line.\n\nUsage:\n    cuff [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 Jackett service if not running.\n        -k                        Stop Jackett service before exiting.\n        -u JACKETT_URL            Jackett URL.\n        -a API_KEY                Jackett API key, will query Jackett if not provided.\n        -p PASSWORD               Jackett password.\n    cuff 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        -t TRACKER                Restrict search to trackers.\n                                  TRACKER must be a configured indexer.\n        -s SORTKEY                Sort results by key.\n    cuff indexers             List configured indexers.\n    cuff categories           List torrent categories.\n    cuff config               Show Jackett config (json).\n    cuff open                 Open the Jackett dashboard using 'qutebrowser'.\n\nExamples:\n    Search for big buck bunny on all configured indexers.\n    $ cuff search big buck bunny\n    Search for big buck bunny movies/tv on tpb indexer.\n    $ cuff search -c movies -c tv -t thepiratebay big buck bunny\n    Search for ubuntu sorted by Seeders.\n    $ cuff search -s Seeders ubuntu\n    Search for ubuntu and output the title and link, format with column.\n    $ cuff search -f '\\(.Title)|\\(.MagnetUri//.Link)' ubuntu | column -t -s\"|\"\n```\n\n# Note\n\nTo use the `-s` and `-k` options to start and stop the `jackett` 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%2Fcuff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floiccoyle%2Fcuff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floiccoyle%2Fcuff/lists"}