{"id":19686158,"url":"https://github.com/loiccoyle/audd-cli","last_synced_at":"2025-06-22T21:36:49.193Z","repository":{"id":116544569,"uuid":"378256797","full_name":"loiccoyle/audd-cli","owner":"loiccoyle","description":"🎵 CLI music recognition using the AudD API","archived":false,"fork":false,"pushed_at":"2021-08-13T21:01:18.000Z","size":18,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-29T06:32:55.099Z","etag":null,"topics":["audd","cli","music","music-recognition","shazam"],"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-06-18T20:19:10.000Z","updated_at":"2025-02-24T20:48:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"9098dce3-9f0d-4309-8c2c-266b046c7d2c","html_url":"https://github.com/loiccoyle/audd-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/loiccoyle/audd-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Faudd-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Faudd-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Faudd-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Faudd-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loiccoyle","download_url":"https://codeload.github.com/loiccoyle/audd-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loiccoyle%2Faudd-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261373546,"owners_count":23148917,"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":["audd","cli","music","music-recognition","shazam"],"created_at":"2024-11-11T18:26:28.611Z","updated_at":"2025-06-22T21:36:44.147Z","avatar_url":"https://github.com/loiccoyle.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# audd-cli\n\n\u003cp align=\"center\"\u003e\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/audd-cli-git/\"\u003e\u003cimg src=\"https://img.shields.io/aur/version/audd-cli-git\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nRecord audio and use the [AudD](https://audd.io) music recognition API from the command line.\n\nThe [`audd`](./audd) scripts queries the AudD API. This repository also contains [`audd-notif`](./audd-notif) which uses [`audd`](./audd) and `libnotify` to return the match result.\n\n## Dependencies:\n\nThe `audd` script requires:\n\n- [curl](https://github.com/curl/curl)\n- [ffmpeg](https://git.ffmpeg.org/ffmpeg.git)\n\nIn addition to the above the `audd-notif` script requires:\n\n- [jq](https://github.com/stedolan/jq)\n- notify-send\n- [dunstify](https://github.com/dunst-project/dunst) (optional)\n\n## Installation\n\n#### Manual\n\nJust clone this repo and place the `audd` and `audd-notif` scripts on your `$PATH`.\n\n#### Arch (AUR):\n\nUsing your favourite AUR helper:\n\n```sh\n$ paru -S audd-cli-git\n```\n\n## Usage\n\n```\n$ audd -h\nUsage: audd [OPTION]... [FILE]\nQuery the AudD music recognition API.\n\nGet a free API token at: https://audd.io/\n\nThe API token can be read from file:\n$ echo \"api-token\" \u003e \"~/.config/audd/api_token\"\n\nIf no FILE is provided, a recording is made using the AUDIO_SOURCE.\n\nUsage:\n    -h                    Show this message and exit.\n    -a API_KEY            AudD API token.\n    -s AUDIO_SOURCE       ffmpeg audio input source, (default: \"default\").\n    -t RECORDING_TIME     Length of recording time, in seconds, (default: 3).\n    -r API_RETURN         AudD API return parameter, see https://docs.audd.io/,\n                          (default: \"apple_music,spotify\").\n    -o                    Use the \"recognizeWithOffset\" endpoint.\n```\n\nTo use `audd` you will need to get an API key from [audd]([https://audd.io).\nProvide the API key with either the `-a` option or by writing the API key to `${XDG_CONFIG_HOME:-$HOME/.config}/audd/api_token`:\n\n```sh\n$ echo \"api-token\" \u003e \"~/.config/audd/api_token\"\n```\n\n`audd` can perform a query using an audio file (the file shouldn't be too large, typically shorter than 20 seconds), or if no file is provided, it will record an audio sample from the provided audio source (`-s` option).\n\nYou can use `ffmpeg -sources pulse` to list available sources.\n\nI recommend reading the [API docs](https://docs.audd.io/) to understand the `-r` and the `-o` options.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floiccoyle%2Faudd-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floiccoyle%2Faudd-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floiccoyle%2Faudd-cli/lists"}