Skip to content

Commit a6f8de3

Browse files
committed
Add readme.
1 parent 4c63023 commit a6f8de3

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# MCAT - Download ALL THE MUSIC
2+
3+
This tool interfaces with the Monster Cat connect API and allows you to download their entire collection.
4+
5+
## Usage:
6+
7+
8+
Select all the good stuff: `mcat syncCatalog && mcat select --uniq-track --no-long-mix --no-remix > things-to-download.json`
9+
10+
Count tracks released after a date `mcat select --after 10-10-2017 --count`
11+
12+
Download the selected items `mcat download < things-to-download.json`
13+
14+
Import the downloaded tracks to iTunes `things-to-download.json > mcat import | sh`
15+
16+
17+
Main Help:
18+
```
19+
CLI tool to interface with the MonsterCat Connect API.
20+
21+
This tool is best used for syncing a target group of tracks with your local machiene (i.e. iTunes).
22+
23+
Commands:
24+
25+
auth - Create a session with the MonsterCat Connnect service.
26+
session - Check the status of the current session.
27+
syncCatalog - Syncs MonsterCat's entire catalog to the local cache.
28+
select - Selects a set of tracks from the cache using the given options.
29+
download - Downloads the tracks the specified file.
30+
importItunes - Imports the paths into iTunes.
31+
logOut - Destroys the current session.
32+
help - Prints this help text.
33+
```
34+
35+
Select Help:
36+
37+
```
38+
Filters songs from the cached MonsterCat Catalog.
39+
40+
Options:
41+
42+
--count - Only outputs the count of matched entries.
43+
--schema - Only outputs the first element to help with filter development.
44+
--help - Prints this text.
45+
--all - Select every entry
46+
--uniq-track - Selects only unique tracks.
47+
--remix - Selects only remixes.
48+
--no-remix - Excludes remixes
49+
--long-mix - Selects only long mixes.
50+
--no-long-mix - Excludes long mixes.
51+
--colab - Selects only songs that have two or more artists.
52+
--no-colab - Selects songs with only one artist.
53+
--featuring - Selects only songs which feature an artist.
54+
--downloadable - Selects only downloadable songs.
55+
--early-access - Selects songs only avalible for early access.
56+
--after - Selects songs created after the specified date.
57+
--before - Selects songs created before the specified date.
58+
```

0 commit comments

Comments
 (0)