Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miraclx/freyr-js
A tool for downloading songs from music streaming services like Spotify and Apple Music.
https://github.com/miraclx/freyr-js
album album-art apple-music artist audio deezer download itunes m4a m4a-format mpeg-4 music music-streaming nodejs playlist spotify spotify-api spotify-web-api track youtube
Last synced: 28 days ago
JSON representation
A tool for downloading songs from music streaming services like Spotify and Apple Music.
- Host: GitHub
- URL: https://github.com/miraclx/freyr-js
- Owner: miraclx
- License: apache-2.0
- Created: 2020-02-25T08:16:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T21:08:13.000Z (about 2 months ago)
- Last Synced: 2024-09-28T03:21:04.968Z (about 1 month ago)
- Topics: album, album-art, apple-music, artist, audio, deezer, download, itunes, m4a, m4a-format, mpeg-4, music, music-streaming, nodejs, playlist, spotify, spotify-api, spotify-web-api, track, youtube
- Language: JavaScript
- Homepage: https://git.io/freyr-js
- Size: 3.45 MB
- Stars: 1,514
- Watchers: 26
- Forks: 95
- Open Issues: 70
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- project-awesome - miraclx/freyr-js - A tool for downloading songs from music streaming services like Spotify and Apple Music. (JavaScript)
- jimsghstars - miraclx/freyr-js - A tool for downloading songs from music streaming services like Spotify and Apple Music. (JavaScript)
README
# Freyr
Download songs from Spotify, Apple Music and Deezer.
[](https://github.com/miraclx)
[](https://www.codefactor.io/repository/github/miraclx/freyr-js/overview/master)
[](https://github.com/miraclx/freyr-js)
[](https://github.com/miraclx/freyr-js/actions/workflows/tests.yml)
[](https://www.npmjs.com/package/freyr)
[](https://hub.docker.com/r/freyrcli/freyrjs)
[](https://github.com/miraclx/freyr-js)
[](https://github.com/miraclx/freyr-js)
[](https://github.com/miraclx/freyr-js)
[](https://github.com/miraclx/freyr-js)
[](https://github.com/miraclx/freyr-js)
Built with ❤︎ by
Miraculous Owonubi
## Demo
[](https://asciinema.org/a/KH5xyBq9G8Wf5Dyvj6AfqXwYr?autoplay=1 "Click to view ASCII")
## Overview
### What freyr does
Depending on the URLs you provide freyr, it will;
1. Extract track metadata (`title`, `album`, `artist`, etc.) from the streaming service (Spotify if you provide a Spotify URL).
2. Then, it queries sources (e.g. YouTube), classifies the results to find you the best sounding, most accurate audio and downloads that in the raw format.
3. Next, it processes each track, encoding them in an [Apple AAC](https://en.wikipedia.org/wiki/Advanced_Audio_Coding) format (`.m4a` file extension) at a default bitrate of `320kbps`.
4. Then, it embeds all the metadata and the album art into each track.
5. And finally, it organizes all the files into a structured library ([example](https://miraclx.github.io/freyr-demo-library/)).
### Metadata Availability
Here's a list of the metadata that freyr can extract from each streaming service:
| Meta | Spotify | Apple Music | Deezer |
| :------------: | :-----: | :---------: | :----: |
| `Title` | ✔ | ✔ | ✔ |
| `Artist` | ✔ | ✔ | ✔ |
| `Composer` | ✗ | ✔ | ✔ |
| `Album` | ✔ | ✔ | ✔ |
| `Genre` | ✗ | ✔ | ✔ |
| `Track Number` | ✔ | ✔ | ✔ |
| `Disk Number` | ✔ | ✔ | ✔ |
| `Release Date` | ✔ | ✔ | ✔ |
| `Rating` | ✔ | ✔ | ✔ |
| `Album Artist` | ✔ | ✔ | ✔ |
| `ISRC` | ✔ | ✔ | ✔ |
| `Label` | ✔ | ✔ | ✔ |
| `Copyright` | ✔ | ✔ | ✔ |
| `Cover Art` | ✔ | ✔ | ✔ |
## Support the project
#### Donate via
[](https://patreon.com/miraclx)
[](https://liberapay.com/miraclx)
[](https://ko-fi.com/miraclx)
#### Crypto
- Via Coinbase (`BTC`, `ETH`, `USDC`, `LTC`, `DAI`, `BCH`):
- Support us with [`$5`](https://commerce.coinbase.com/checkout/96849d29-e051-4855-8bac-97f3f2e1a7a8) | [`$10`](https://commerce.coinbase.com/checkout/c8901c03-217a-475a-a764-98cdc6f561e9) | [`$15`](https://commerce.coinbase.com/checkout/e9be7d37-1ee7-4cc6-9daf-fde68c0697cc) | [`$20`](https://commerce.coinbase.com/checkout/4254e8a5-2071-445c-a0bd-c43a4e0d09b0)
- Donate [anything you want](https://commerce.coinbase.com/checkout/466d703a-fbd7-41c9-8366-9bdd3e240755)
- Or Directly:
- [](https://explorer.btc.com/btc/address/bc1qqe5y9kw7ewne8njdces8e4ajx5u7zhfftdvl33): `bc1qqe5y9kw7ewne8njdces8e4ajx5u7zhfftdvl33`
- [](https://keybase.io/miraclx): `GB6GPPXXJTQ6EFYQQ4PFA4WEAT5G2DIDILOEDLYH76743UUVDDU4KOWY`
- [](https://keybase.io/miraclx): `zs10awcwm4uwpjr3mxxdwe03fda0j0zn95s4hu3qxlvhfajjw8es98ftmpaava7zh735x9s22pan0l`
## Installation
### Manually
Requirements
_Hey there, you might want to consider a cleaner and straight-forward installation method, without having to manually setup the requirements. If so, checkout the [Docker installation method](#docker)_
python >= v3.2
Download for your individual platforms here
Linux: _(check individual package managers)_
- Debian: `sudo apt-get install python3.6`
- Arch Linux: `sudo pacman -S python`
- Android (Termux): `apt install python`
- Alpine Linux: `sudo apk add python3`
nodejs >= v16.0.0
Download for your individual platforms here
macOS + Linux: [nvm](https://github.com/nvm-sh/nvm) recommended.
```bash
# install node with this nvm command
# freyr works with a minimum of v16
$ nvm install --lts
```
- Android (Termux): `apt install nodejs`
- Alpine Linux: `sudo apk add nodejs`
AtomicParsley >= 20230114
First, download the latest release for your individual platforms here
Then;
- Windows:
- unzip and place the `AtomicParsley.exe` in your `PATH`.
- or the `bins/windows` folder of this project directory. Create the folder(s) if they don't exist.
- Linux + macOS:
- unzip and place the `AtomicParsley` in your `PATH`.
- or the `bins/posix` folder of this project directory. Create the folder(s) if they don't exist.
- Alternatively:
- Debian: `sudo apt-get install atomicparsley`
- Arch Linux: `sudo pacman -S atomicparsley`
- Android (Termux): `apt install atomicparsley`
- Build from source: See [wez/AtomicParsley](https://github.com/miraclx/atomicparsley)
> _Please note that [YouTube Music](https://music.youtube.com/) must be available in your region for freyr to successfully work, this is because freyr sources raw audio from [YouTube Music](https://music.youtube.com/)._
---
First start by ensuring all requirements listed above are satisfied. Thereafter, you can use either of these options to install freyr:
- [NPM](https://github.com/npm/cli): `npm install -g freyr`
- [Yarn](https://github.com/yarnpkg/yarn): `yarn global add freyr`
-
Or you can build from source
```bash
git clone https://github.com/miraclx/freyr-js.git freyr
cd freyr
```
| % | NPM | Yarn |
| ----------------- | ------------- | -------------- |
| pull dependencies | `npm install` | `yarn install` |
| install globally | `npm link` | `yarn link` |
### Docker
For convenience, we provide [officially prebuilt images](https://hub.docker.com/r/freyrcli/freyrjs/tags?name=latest) (automated builds from this repository) so you can skip the setup and build process and get right into it.
Image Size: [](https://hub.docker.com/r/freyrcli/freyrjs/tags?name=latest)
#### Usage (docker)
```bash
docker run -it --rm -v $PWD:/data freyrcli/freyrjs [options, arguments and queries...]
```
You can also create a handy alias to skip remembering that whole line everytime
```bash
alias freyr='docker run -it --rm -v $PWD:/data freyrcli/freyrjs'
```
> The `-v $PWD:/data` part sets the working directory for freyr to the current working directory.
> For example, you can use `-v ~/Music/freyr:/data` to set the work directory and consequently, default save location to `~/Music/freyr`.
>
> Please ensure the folder on the host already exists, create it if not. Otherwise, docker autocreates the folder as root and that causes unpleasant `Permission Denied` issues when you run freyr.
[See [Docker Development](#docker-development)]
## Getting Started
### Usage
```text
Usage: freyr [options] [query...]
Usage: freyr [options] [subcommand]
```
[See [Service Support](#service-support)].
#### Show freyr help and list subcommands
`freyr --help`
#### Get CLI Help
*The `get` subcommand is implicit and default.
```text
Usage: freyr [options] get [options] [query...]
Usage: freyr [options] [query...]
```
freyr get --help
```console
____
/ __/_______ __ _______
/ /_/ ___/ _ \/ / / / ___/
/ __/ / / __/ /_/ / /
/_/ /_/ \___/\__, /_/
/____/ v0.10.3
freyr - (c) Miraculous Owonubi
------------------------------------------------------
Usage: freyr get [options] [query...]
Download music tracks from queries
Options:
-i, --input use URIs found in the specified FILE as queries (file size limit: 1 MiB)
(each query on a new line, use '#' for comments, whitespaces ignored)
(example: `-i queue.txt`)
-b, --bitrate set audio quality / bitrate for audio encoding
(valid: 96,128,160,192,256,320) (default: "320k")
-n, --chunks number of concurrent chunk streams with which to download (default: 7)
-r, --retries set number of retries for each chunk before giving up
(`infinite` for infinite) (default: 10)
-t, --meta-retries set number of retries for collating track feeds (`infinite` for infinite) (default: 5)
-d, --directory save tracks to DIR/..
-D, --check-dir check if tracks already exist in another DIR (repeatable, optionally comma-separated)
(useful if you maintain multiple libraries)
(example: `-D dir1 -D dir2 -D dir3,dir4`)
-c, --cover custom name for the cover art, excluding the extension (default: "cover")
--cover-size preferred cover art dimensions
(format: x or as x) (default: "640x640")
-C, --no-cover skip saving a cover art
-S, --sources specify a preferred audio source or a `,`-separated preference order
(valid: youtube,yt_music) (prefix with `!` to exclude) (default: "yt_music")
-l, --filter filter matches off patterns (repeatable and optionally `,`-separated)
(value omission implies `true` if applicable)
(format: ) (example: title="when we all fall asleep*",type=album)
See `freyr help filter` for more information
-L, --filter-case enable case sensitivity for glob matches on the filters
-z, --concurrency key-value concurrency pairs (repeatable and optionally `,`-separated)
(format: <[key=]value>) (key omission implies track concurrency)
(valid(key): queries,tracks,trackStage,downloader,encoder,embedder)
(example: `queries=2,downloader=4` processes 2 CLI queries,
downloads at most 4 tracks concurrently)
--gapless set the gapless playback flag for all tracks
-f, --force force overwrite of existing files
-o, --config specify alternative configuration file
-p, --playlist create playlist for all successfully collated tracks
-P, --no-playlist skip creating a playlist file for collections
--playlist-dir directory to save playlist file to, if any, (default: tracks base directory)
--playlist-noappend do not append to the playlist file, if any exists
--playlist-noescape do not escape invalid characters within playlist entries
--playlist-namespace namespace to prefix on each track entry, relative to tracks base directory
useful for, but not limited to custom (file:// or http://) entries
(example, you can prefix with a HTTP domain path: `http://webpage.com/music`)
--playlist-force-append force append collection tracks to the playlist file
-s, --storefront country storefront code (example: us,uk,ru)
-T, --no-tree don't organise tracks in directory structure `[DIR/]//`
--cache-dir specify alternative cache directory
`` for tempdir, `` for system cache
--rm-cache [RM] remove original downloaded files in cache directory (default: false)
-m, --mem-cache max size of bytes to be cached in-memory for each download chunk
--no-mem-cache disable in-memory chunk caching (restricts to sequential download)
--timeout network inactivity timeout (ms) (default: 10000)
--no-auth skip authentication procedure
--no-browser disable auto-launching of user browser
--no-net-check disable internet connection check
--no-bar disable the progress bar
--atomic-parsley explicit path to the atomic-parsley binary
--no-stats don't show the stats on completion
--pulsate-bar show a pulsating bar
--single-bar show a single bar for the download, hide chunk-view
(default when number of chunks/segments exceed printable space)
-h, --help show this help information
Environment Variables:
SHOW_DEBUG_STACK show extended debug information
ATOMIC_PARSLEY_PATH custom AtomicParsley path, alternatively use `--atomic-parsley`
Info:
When downloading playlists, the tracks are downloaded individually into
their respective folders. However, a m3u8 playlist file is generated in
the base directory with the name of the playlist that lists the tracks
```
#### Download a Spotify track
freyr spotify:track:5FNS5Vj69AhRGJWjhrAd01
```console
____
/ __/_______ __ _______
/ /_/ ___/ _ \/ / / / ___/
/ __/ / / __/ /_/ / /
/_/ /_/ \___/\__, /_/
/____/ v0.10.3
freyr - (c) Miraculous Owonubi
-------------------------------------------------------------
Checking directory permissions...[done]
[spotify:track:5FNS5Vj69AhRGJWjhrAd01]
[•] Identifying service...[Spotify]
[•] Checking authentication...[unauthenticated]
[Spotify Login]
[•] Logging in...[done]
Detected [track]
Obtaining track metadata...[done]
➤ Title: Slow Dance
➤ Album: Slow Dance
➤ Artist: AJ Mitchell
➤ Year: 2019
➤ Playtime: 02:58
[•] Collating...
• [01 Slow Dance]
| ➤ Collating sources...
| ➤ [•] YouTube Music...[success, found 1 source]
| ➤ Awaiting audiofeeds...[done]
| [✓] Got album art
| [✓] Got raw track file
| [•] Post Processing...
[•] Download Complete
[•] Embedding Metadata...
• [✓] 01 Slow Dance
[•] Collation Complete
============ Stats ============
[•] Runtime: [31.7s]
[•] Total queries: [01]
[•] Total tracks: [01]
» Skipped: [00]
✓ Passed: [01]
✕ Failed: [00]
[•] Output directory: [.]
[•] Cover Art: cover.png (640x640)
[•] Total Output size: 7.30 MB
[•] Total Network Usage: 3.12 MB
♫ Media: 3.02 MB
➤ Album Art: 106.76 KB
[•] Output bitrate: 320k
===============================
```
#### Download an Apple Music album
freyr https://music.apple.com/us/album/im-sorry-im-not-sorry-ep/1491795443
```console
____
/ __/_______ __ _______
/ /_/ ___/ _ \/ / / / ___/
/ __/ / / __/ /_/ / /
/_/ /_/ \___/\__, /_/
/____/ v0.10.3
freyr - (c) Miraculous Owonubi
-------------------------------------------------------------
Checking directory permissions...[done]
[https://music.apple.com/us/album/im-sorry-im-not-sorry-ep/1491795443]
[•] Identifying service...[Apple Music]
[•] Checking authentication...[authenticated]
Detected [album]
Obtaining album metadata...[done]
➤ Album Name: I'm Sorry, I'm Not Sorry
➤ Artist: Sody
➤ Tracks: 4
➤ Type: Album
➤ Year: 2020
➤ Genres: Singer/Songwriter, Music
[•] Collating [I'm Sorry, I'm Not Sorry]...
[•] Inquiring tracks...[done]
• [01 What We Had]
| ➤ Collating sources...
| ➤ [•] YouTube Music...[success, found 4 sources]
| ➤ Awaiting audiofeeds...[done]
| [✓] Got album art
| [✓] Got raw track file
| [•] Post Processing...
• [02 Reason To Stay]
| ➤ Collating sources...
| ➤ [•] YouTube Music...[success, found 6 sources]
| ➤ Awaiting audiofeeds...[done]
| [✓] Got album art
| [✓] Got raw track file
| [•] Post Processing...
• [03 Nothing Ever Changes]
| ➤ Collating sources...
| ➤ [•] YouTube Music...[success, found 4 sources]
| ➤ Awaiting audiofeeds...[done]
| [✓] Got album art
| [✓] Got raw track file
| [•] Post Processing...
• [04 Love's a Waste]
| ➤ Collating sources...
| ➤ [•] YouTube Music...[success, found 4 sources]
| ➤ Awaiting audiofeeds...[done]
| [✓] Got album art
| [✓] Got raw track file
| [•] Post Processing...
[•] Download Complete
[•] Embedding Metadata...
• [✓] 01 What We Had
• [✓] 02 Reason To Stay
• [✓] 03 Nothing Ever Changes
• [✓] 04 Love's a Waste
[•] Collation Complete
============ Stats ============
[•] Runtime: [2m 2.3s]
[•] Total queries: [01]
[•] Total tracks: [04]
» Skipped: [00]
✓ Passed: [04]
✕ Failed: [00]
[•] Output directory: [.]
[•] Cover Art: cover.png (640x640)
[•] Total Output size: 29.79 MB
[•] Total Network Usage: 13.35 MB
♫ Media: 12.73 MB
➤ Album Art: 619.43 KB
[•] Output bitrate: 320k
===============================
```
#### Download a Deezer Artist
freyr https://www.deezer.com/us/artist/14808825
```console
____
/ __/_______ __ _______
/ /_/ ___/ _ \/ / / / ___/
/ __/ / / __/ /_/ / /
/_/ /_/ \___/\__, /_/
/____/ v0.10.3
freyr - (c) Miraculous Owonubi
-------------------------------------------------------------
Checking directory permissions...[done]
[https://www.deezer.com/us/artist/14808825]
[•] Identifying service...[Deezer]
[•] Checking authentication...[authenticated]
Detected [artist]
Obtaining artist metadata...[done]
➤ Artist: Mazie
➤ Followers: 6
> Gathering collections...[done]
[•] Collating...
(01) [i think i wanna be alone] (single)
[•] Inquiring tracks...[done]
• [01 i think i wanna be alone]
| ➤ Collating sources...
| ➤ [•] YouTube Music...[success, found 2 sources]
| ➤ Awaiting audiofeeds...[done]
| [✓] Got album art
| [✓] Got raw track file
| [•] Post Processing...
(02) [no friends] (single)
[•] Inquiring tracks...[done]
• [01 no friends]
| ➤ Collating sources...
| ➤ [•] YouTube Music...[success, found 4 sources]
| ➤ Awaiting audiofeeds...[done]
| [✓] Got album art
| [✓] Got raw track file
| [•] Post Processing...
[•] Download Complete
[•] Embedding Metadata...
• [✓] 01 i think i wanna be alone
• [✓] 01 no friends
[•] Collation Complete
============ Stats ============
[•] Runtime: [54.6s]
[•] Total queries: [01]
[•] Total tracks: [02]
» Skipped: [00]
✓ Passed: [02]
✕ Failed: [00]
[•] Output directory: [.]
[•] Cover Art: cover.png (640x640)
[•] Total Output size: 8.47 MB
[•] Total Network Usage: 3.66 MB
♫ Media: 3.50 MB
➤ Album Art: 157.16 KB
[•] Output bitrate: 320k
===============================
```
#### Batch downloads
##### via Arguments
Queries can be collated to be processed at once.
```bash
freyr query1 query2 ... queryN
```
##### via Batch File
Queries can be batched into a file and loaded all at once with the `-i, --input ` flag.
Queries should be on separate lines.
Lines starting with a `#` are treated as comments and ignored. comments can also be inlined with everything following the `#` character ignored.
```text
# ./queue.txt
# Hailee Steinfeld
https://open.spotify.com/track/5Gu0PDLN4YJeW75PpBSg9p # (track) Let Me Go
https://open.spotify.com/track/7GCVboEDzfL3NKp1NrAgHR # (track) Wrong Direction
# (album) Rina Sawayama
https://open.spotify.com/album/3stadz88XVpHcXnVYMHc4J
```
```bash
freyr -i ./queue.txt
```
Use the [`--help`](#get-cli-help) flag to see full usage documentation.
#### URIs
Services can be queried with short URIs containing the type and ID for the resource.
identifier
type
id
URI Short Tags
:
track
:
~
album
artist
playlist
Use the `urify` subcommand to parse betweeen URIs and its equivalent URL representation, and vice-versa.
Creating freyr-compatible queue output.
freyr urify https://open.spotify.com/album/2D23kwwoy2JpZVuJwzE42B --no-header --no-logo --no-tag
```text
spotify:album:2D23kwwoy2JpZVuJwzE42B
[+] Urify complete
```
freyr urify -i queue_of_urls.txt -o queue_of_uris.txt --no-header --no-logo
```text
[+] Urify complete
Successfully written to [queue_of_uris.txt]
```
[Examples](#ssue)
### Features
- Multi-service support [See [Service Support](#service-support)]
- Playlist generation (per playlist (default) / per query (optional))
- Batch download from queue file
- Simultaneous chunked downloads (powered by [[libxget-js](https://github.com/miraclx/libxget-js)])
- Efficient concurrency
- Bitrate specification (valid: 96, 128, 160, 192, 256, 320)
- Album art embedding & export
- Proper track organisation i.e `FOLDER///` ([example](https://miraclx.github.io/freyr-demo-library/))
- Resilient visual progressbar per track download (powered by [[xprogress](https://github.com/miraclx/xprogress)])
- Stats on runtime completion
- runtime duration
- number of successfully processed tracks
- output directory
- cover art name
- total output size
- total network usage
- network usage for media
- network usage for album art
- output bitrate
### Configuration
User / Session specific configuration
Persistent configuration such as authentication keys and their validity period are stored within a session specific configuration file.
This configuration file resides within the user config directory per-platform.
- `$HOME/.config/FreyrCLI/d3fault.x4p` for Linux.
- `$HOME/Library/Preferences/FreyrCLI/d3fault.x4p` for macOS.
Project specific configuration
All defaults are defined in the [conf.json](https://github.com/miraclx/freyr-js/blob/master/conf.json) file at the root of the project. This file should be of `JSON` format and is to be structured as such.
Do not edit this file directly, instead run freyr once and edit the user specific configuration (see above).
- `server`: \ The server URL configuration same as on an individual services' callback option.
- `hostname`: \
- `port`: \
- `useHttps`: \
- `concurrency`: \
- `queries`: \ The number of queries to be processed concurrently.
- `tracks`: \ The number of tracks to be actively processed in parallel.
- `trackStage`: \ The number of tracks to concurrently preprocess before being pushed to the main trackQueue.
- `downloader`: \ The number of tracks to be concurrently downloaded in parallel.
- `encoder`: \ The total number of tracks to be concurrently undergo encoding.
- `embedder`: \ The total number of tracks to be concurrently embedded in parallel.
- `opts`: \
- `netCheck`: \ Whether or not to check network access at program start.
- `attemptAuth`: \ Whether or not to process authentication.
- `autoOpenBrowser`: \ Whether or not to automatically open user browser.
- `filters`: \<[FilterRules](#filterrules)[]\> Filter rules each track must match to be downloaded.
- `dirs`: \
- `output`: \ Default download directory. Default: `"."`
- `check`: \ List of directories to check for existing files. Default: `["."]`
- `cache`: \
- `path`: \ Path to download pre-processed audio to (`""` for tempdir, `""` for system cache). Default: `""`
- `keep`: \ Whether or not to keep the pre-processed audio. Default: `"true"`
- `playlist`: \
- `always`: \ Always create playlists for collections and non-collections alike.
- `append`: \ Append non-collection tracks onto the playlist file.
- `escape`: \ Escape `#` characters within playlist entries paths.
- `forceAppend`: \ Force append collection tracks.
- `dir`: \ Default playlist save directory.
- `namespace`: \ Prefix namespace to prepend to track paths.
- `image`: \ An object with fields pertaining to an image's properties or a number defining its size. (\x\ or \ as \x\)
- `width`: \
- `height`: \
- `downloader`: \
- `memCache`: \ Whether or not to use in-memory caching for download chunks.
- `cacheSize`: \ Maximum size of bytes to be cached per download.
- `sources`: \ Service download sources order.
- Freyr would check these download sources in the order which they are defined. Failure to get a query from a source would try the next available source. You can exclude a source by prefixing it with a `!` character.
- supported: `youtube`, `yt_music`
- default: `[ "yt_music", "youtube" ]`
- `services`: \<[ServiceConfiguration](#service-configuration): object\>
Example JSON
```json
{
"server": {
"hostname": "localhost",
"port": 36346,
"useHttps": false
},
"image": {
"width": 640,
"height": 640
},
"services": {
"spotify": {
"clientId": "CLIENT_ID",
"clientSecret": "CLIENT_SECRET",
"refreshToken": "OPTIONAL_REFRESH_TOKEN"
},
"apple_music": {
"storefront": "us"
},
"deezer": {
"retries": 5
}
}
}
```
### Service Configuration
The [conf.json](https://github.com/miraclx/freyr-js/blob/master/conf.json) file already includes some API tokens for service authentication and should work right out of the box. [See [Project specific configuration](#project-specific-configuration)]
Spotify
- `spotify`: \
- `clientId`: \
- `clientSecret`: \
- `refreshToken`: \
Spotify requires a `clientId` and a `clientSecret` that can be gotten from their developer dashboard.
If you wish to create and use custom keys, [See [Spotify API Authorization](#spotify-api-authorization)].
An optional `refreshToken` option can be defined which can be used to authenticate a session without necessarily requesting explicit permissions. The `refreshToken` is already bound to a pre-authenticated account.
An invalid `refreshToken`, when specified, would fallback to requesting account access which in-turn would request re-authentication of the users' account.
#### Spotify API Authorization
1. Sign in to the [Spotify Dashboard](https://developer.spotify.com/dashboard/)
2. Click `CREATE A CLIENT ID` and create an app
3. Now click `Edit Settings`
4. Add `http://localhost:36346/callback` to the Redirect URIs
5. Include the `clientId` and the `clientSecret` from the dashboard in the `spotify` object that is a property of the `services` object of the `conf.json` file. [See [Configuration](#configuration)]
6. You are now ready to authenticate with Spotify!
Apple Music
- `apple_music`: \
- `storefront`: \
- `developerToken`: \
Freyr would automatically fetch a developer token from the Apple Music site, which should suffice for all intents and purposes. But if you prefer to use a custom developer token, please refer to the Apple Music documentation on this topic.
The `storefront` option defines the default storefront to be used in the absence of a specification.
#### Apple Music API Authorization
[See [Apple Music API: Getting Keys and Creating Tokens](https://developer.apple.com/documentation/applemusicapi/getting_keys_and_creating_tokens)]
After successfully acquiring the developer token, include the `developerToken` to the `apple_music` object that's a property of the `services` object in the `conf.json` file. [See [Configuration](#configuration)]
An expired developer token in the `conf.json` would make freyr fallback to fetching it from the Apple Music site.
Deezer
- `deezer`: \
- `retries`: \
Authentication unrequired. API is freely accessible.
Because of the 50 requests / 5 seconds limit enforced on an IP-basis for Deezer's API [See [#32](https://github.com/miraclx/freyr-js/issues/32)],
occasionally a `Quota limit exceeded` error would be thrown by the API server.
To combat this, freyr employs request batching, managed delays and finally, retries when things go awry.
You can configure how many retries you want freyr to make before accepting failure.
### Return Codes
- 0: OK
- 1: Invalid query
- 2: Invalid flag value
- 3: Invalid / Inexistent configuration file
- 4: Network error
- 5: Error with working directory
- 6: Failed to initialize a freyr instance
- 7: An error occurred checking dependency paths
### FilterRules
Filter rules each to be matched against the tracks involved in any operation.
Used as values to the `-l, --filter` flag or as key-value pairs in the `filters` array of the [configuration file](#project-specific-configuration).
| key | syntax | description | examples |
| -------------- | :-----------: | --------------- | -------- |
| `id` | glob | Resource ID | `id=1497949287`, `id=*149` |
| `uri` | glob | Resource URI | `uri="*:+(track\|album):*"` |
| `title` | glob | Track title | `title="all*good girls*hell"` |
| `album` | glob | Track album | `album="when we*fall*do we go*"` |
| `artist` | glob | Match an artist | `artist="Billie*"` | |
| `trackn` | [Numeric Range](#ranges) | Match a track number range | `trackn="2..5"`, `trackn="4..=5"` |
| `type` | Static | `album` \| `single` \| `compilation` | `type=single` |
| `duration` | [Timed Range](#timed-ranges) | Track duration | `duration="3s.."`, `duration="2:30..3:00"`, `duration="..=3m"` |
| `explicit` | Static | `true` \| `false` \| `inoffensive` | `explicit=true`, `explicit=inoffensive` |
| `album_artist` | glob | Album artist | `album_artist="Billie Eilish"` |
| `isrc` | glob | Track ISRC | `isrc=USUM71900766` |
| `label` | glob | Record label | `label="*Interscope*"` |
| `year` | [Numeric Range](#ranges) | Release year | `year=2019`, `year=2018..2020` |
| `diskn` | [Numeric Range](#ranges) | Disk number | `diskn=1` |
| `ntracks` | [Numeric Range](#ranges) | Number of tracks in the album | `ntracks=10..=14` |
#### Ranges
Syntax: `[a][..][[=]b]`
| Spec | Match | Representation |
| ------- | ---------------- | -------------- |
| `..` | `-∞ ... ∞` | `x` |
| `3..7` | `3, 4, 5, 6` | `7 > x ≥ 3` |
| `3..=7` | `3, 4, 5, 6, 7` | `7 ≥ x ≥ 3` |
| `..3` | `-∞ ... 0, 1, 2` | `3 > x` |
| `..=3` | `-∞ ... 1, 2, 3` | `3 ≥ x` |
| `5..` | `5, 6, 7 ... ∞` | `x ≥ 5` |
#### Timed Ranges
Examples: `duration=60s..=3:40`
| Metric | Values |
| ------- | ------------------------ |
| Seconds | `30`, `30s`, `00:30` |
| Minutes | `120`, `120s`, `02:00` |
| Hours | `5400`, `5400s`, `01:30` |
#### Previewing filter representation
To preview filter rules specification, use the `filter` subcommand.
freyr filter title="all*good girls*hell",artist="*eilish",trackn="4..=5" --no-header --no-logo
```text
[
{
"query": "*",
"filters": {
"title": "all*good girls*hell",
"artist": "*eilish",
"trackn": "4..=5"
}
}
]
```
## Service Support
| Service | Track | Album | Artist | Playlist | [URI Short Tags](#uris) |
| :-----: | :---: | :---: | :----: | :------: | :------------: |
| [Spotify](https://github.com/miraclx/freyr-js/blob/master/src/services/spotify.js) | ✔ | ✔ | ✔ | ✔ | `spotify:` |
| [Apple Music](https://github.com/miraclx/freyr-js/blob/master/src/services/apple_music.js) | ✔ | ✔ | ✔ | ✔ | `apple_music:` |
| [Deezer](https://github.com/miraclx/freyr-js/blob/master/src/services/deezer.js) | ✔ | ✔ | ✔ | ✔ | `deezer:` |
| YouTube Music (See [#6](https://github.com/miraclx/freyr-js/issues/6)) | ✗ | ✗ | ✗ | ✗ | ✗ |
| Tidal (See [#33](https://github.com/miraclx/freyr-js/issues/33)) | ✗ | ✗ | ✗ | ✗ | ✗ |
Short Service URI Examples
Service
Resource Type
URIS
Spotify
track
URL
https://open.spotify.com/track/127QTOFJsJQp5LbJbu3A1y
URI
spotify:track:127QTOFJsJQp5LbJbu3A1y
album
URL
https://open.spotify.com/album/623PL2MBg50Br5dLXC9E9e
URI
spotify:album:623PL2MBg50Br5dLXC9E9e
artist
URL
https://open.spotify.com/artist/6M2wZ9GZgrQXHCFfjv46we
URI
spotify:artist:6M2wZ9GZgrQXHCFfjv46we
playlist
URL
https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M
URI
spotify:playlist:37i9dQZF1DXcBWIGoYBM5M
Apple Music
track
URL
https://music.apple.com/us/album/say-so-feat-nicki-minaj/1510821672?i=1510821685
URI
apple_music:track:1510821685
URL
https://music.apple.com/us/song/1510821685
URI
apple_music:track:1510821685
album
URL
https://music.apple.com/us/album/birds-of-prey-the-album/1493581254
URI
apple_music:album:1493581254
artist
URL
https://music.apple.com/us/artist/412778295
URI
apple_music:artist:412778295
playlist
URL
https://music.apple.com/us/playlist/todays-hits/pl.f4d106fed2bd41149aaacabb233eb5eb
URI
apple_music:playlist:pl.f4d106fed2bd41149aaacabb233eb5eb
Deezer
track
URL
https://www.deezer.com/en/track/642674232
URI
deezer:track:642674232
album
URL
https://www.deezer.com/en/album/99687992
URI
deezer:album:99687992
artist
URL
https://www.deezer.com/en/artist/5340439
URI
deezer:artist:5340439
playlist
URL
https://www.deezer.com/en/playlist/1963962142
URI
deezer:playlist:1963962142
## Development
### Manually Building
Feel free to clone and use in adherance to the [license](#license). Pull requests are very much welcome.
```bash
git clone https://github.com/miraclx/freyr-js.git freyr
cd freyr
```
- If using [NPM](https://github.com/npm/cli):
```bash
npm install
# to have access to the freyr command globally
npm link
```
- If using [Yarn](https://github.com/yarnpkg/yarn):
```bash
yarn install
# to have access to the freyr command globally
yarn link
```
### Testing
Freyr comes bundled with a lightweight test suite. See [TEST.md](https://github.com/miraclx/freyr-js/blob/master/TEST.md) for instructions on how to run it.
### Docker Development
With docker, you can drop into a sandbox that has all the dependencies you need. Without needing to mess around with your host system or install any weird dependencies.
First, you need to either build a local docker image or submit a PR and use the corresponding auto-generated image.
#### Building A Local Image
The default provided [Dockerfile](https://github.com/miraclx/freyr-js/raw/master/Dockerfile) builds minimal alpine images. Average build network usage is ~ 80 MB and disk usage is ~ 180 MB.
```bash
git clone https://github.com/miraclx/freyr-js.git freyr
cd freyr
docker build -t freyr-dev .
```
#### Working With Remote Images
An alternative to building the docker image locally is to use a remote image. By default, all PRs submitted to this repository get an equivalently tagged docker image for testing.
For example, the PR #214 has a docker image called `freyrcli/freyrjs-git:pr-214`. And it stays updated with the current state of the branch.
You can then pull the development image for use locally.
```bash
docker pull freyrcli/freyrjs-git:pr-214
```
---
Once you have a built development image locally, you're ready to go. You can drop into the container by explicitly defining the entrypoint
```bash
docker run -it --entrypoint bash freyr-dev
# Alternatively, create a handy alias
alias freyrsh='docker run -it --entrypoint bash freyr-dev'
```
*: don't forget to replace `freyr-dev` with the appropriate image name if you pulled one of the auto-generated remote images.
Optionally, you can use these interesting flags to customize the experience.
- `-h freyr-dev` sets the container hostname to `freyr-dev`
- `-m 1G` sets the container memory limit
- `-v $PWD:/data` mounts the current working directory to `/data` within the container.
- `--cpus 2` limits the container to using 2 CPU cores
The freyr source would be available in the `/freyr` directory within the container along with a globally registered command `freyr` for calling the script.
For more information and documentation about docker, please refer to its official site:
-
-
## License
[Apache 2.0][license] © **Miraculous Owonubi** ([@miraclx][author-url]) \<\>
[license]: LICENSE "Apache 2.0 License"
[author-url]: https://github.com/miraclx