-
Notifications
You must be signed in to change notification settings - Fork 101
/
Copy pathusage.html
188 lines (173 loc) · 15 KB
/
usage.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../">
<title data-ice="title">Usage</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
</head>
<body class="layout-container manual-root" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="./manual/index.html" data-ice="manualHeaderLink">Manual</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<a href="test.html" data-ice="testLink">Test</a>
<a data-ice="repoURL" href="https://github.com/popcorn-official/popcorn-api.git" class="repo-url-github">Repository</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div class="manual-toc-root">
<div data-ice="manual" data-toc-name="overview">
<h1 class="manual-toc-title"><a href="manual/overview.html" data-ice="title">Overview</a></h1>
<ul class="manual-toc">
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/overview.html#overview" data-ice="link">Overview</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/overview.html#documentation" data-ice="link">Documentation</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/overview.html#folder-structure" data-ice="link">Folder structure</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/overview.html#versioning" data-ice="link">Versioning</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/overview.html#license" data-ice="link">License</a></li>
</ul>
</div>
<div data-ice="manual" data-toc-name="installation">
<h1 class="manual-toc-title"><a href="manual/installation.html" data-ice="title">Installation</a></h1>
<ul class="manual-toc">
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/installation.html#installation" data-ice="link">Installation</a></li>
</ul>
</div>
<div data-ice="manual" data-toc-name="tutorial">
<h1 class="manual-toc-title"><a href="manual/tutorial.html" data-ice="title">Tutorial</a></h1>
<ul class="manual-toc">
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/tutorial.html#tutorial" data-ice="link">Tutorial</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/tutorial.html#scraper" data-ice="link">Scraper</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/tutorial.html#content-providers" data-ice="link">Content Providers</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#extratorrent" data-ice="link">ExtraTorrent</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#eztv" data-ice="link">EZTV</a></li>
<li data-ice="manualNav" class="indent-h4"><span class="manual-dot"></span><a href="manual/tutorial.html#getallshows" data-ice="link">getAllShows</a></li>
<li data-ice="manualNav" class="indent-h4"><span class="manual-dot"></span><a href="manual/tutorial.html#getshowdata" data-ice="link">getShowData</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#horriblesubs" data-ice="link">Horriblesubs</a></li>
<li data-ice="manualNav" class="indent-h4"><span class="manual-dot"></span><a href="manual/tutorial.html#getallanime" data-ice="link">getAllAnime</a></li>
<li data-ice="manualNav" class="indent-h4"><span class="manual-dot"></span><a href="manual/tutorial.html#getanimedata" data-ice="link">getAnimeData</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#kat" data-ice="link">KAT</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#nyaa" data-ice="link">Nyaa</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#yts" data-ice="link">YTS</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/tutorial.html#extractors" data-ice="link">Extractors</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#base-extractor" data-ice="link">Base Extractor</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#anime-extractor" data-ice="link">Anime Extractor</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#movie-extractor" data-ice="link">Movie Extractor</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#show-extractor" data-ice="link">Show Extractor</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/tutorial.html#helpers" data-ice="link">Helpers</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#anime-show-helpers" data-ice="link">Anime & Show Helpers</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#movie-helper" data-ice="link">Movie Helper</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/tutorial.html#metadata-providers" data-ice="link">Metadata Providers</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#-trakt-tv-https-trakt-tv-" data-ice="link">Trakt.tv</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#-thetvdb-com-https-thetvdb-com-" data-ice="link">TheTVDB.com</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#-hummingbird-me-https-hummingbird-me-" data-ice="link">Hummingbird.me</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/tutorial.html#-fanart-tv-https-fanart-tv-" data-ice="link">Fanart.tv</a></li>
</ul>
</div>
<div data-ice="manual" data-toc-name="usage">
<h1 class="manual-toc-title"><a href="manual/usage.html" data-ice="title">Usage</a></h1>
<ul class="manual-toc">
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/usage.html#usage" data-ice="link">Usage</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/usage.html#npm" data-ice="link">npm</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/usage.html#gulp" data-ice="link">Gulp</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/usage.html#global" data-ice="link">Global</a></li>
</ul>
</div>
<div data-ice="manual" data-toc-name="example">
<h1 class="manual-toc-title"><a href="manual/example.html" data-ice="title">Example</a></h1>
<ul class="manual-toc">
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/example.html#example" data-ice="link">Example</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#index" data-ice="link">Index</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#logs" data-ice="link">Logs</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#export" data-ice="link">Export</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#anime" data-ice="link">Anime</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#movie" data-ice="link">Movie</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#show" data-ice="link">Show</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/example.html#query-strings" data-ice="link">Query strings</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#sorting" data-ice="link">Sorting</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#ordering" data-ice="link">Ordering</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#genres" data-ice="link">Genres</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/example.html#movies-shows" data-ice="link">Movies & Shows</a></li>
<li data-ice="manualNav" class="indent-h3"><span class="manual-dot"></span><a href="manual/example.html#anime" data-ice="link">Anime</a></li>
<li data-ice="manualNav" class="indent-h2"><span class="manual-dot"></span><a href="manual/example.html#keywords" data-ice="link">Keywords</a></li>
</ul>
</div>
<div data-ice="manual" data-toc-name="reference">
<h1 class="manual-toc-title"><a href="identifiers.html" data-ice="title">Reference</a></h1>
<ul class="manual-toc">
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="identifiers.html#class" data-ice="link">Class</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="identifiers.html#variable" data-ice="link">Variable</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="identifiers.html#external" data-ice="link">External</a></li>
</ul>
</div>
<div data-ice="manual" data-toc-name="changelog">
<h1 class="manual-toc-title"><a href="manual/changelog.html" data-ice="title">Changelog</a></h1>
<ul class="manual-toc">
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#2-2-2-the-key-is-in-the-words-26-october-2016" data-ice="link">2.2.2 - The key is in the words - 26 October 2016</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#2-2-1-that-s-for-later-23-august-2016" data-ice="link">2.2.1 - That's for later - 23 August 2016</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#2-2-0-extra-torrents-11-august-2016" data-ice="link">2.2.0 - Extra Torrents? - 11 August 2016</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#2-1-0-you-weeaboos-2-august-2016" data-ice="link">2.1.0 - You weeaboos - 2 August 2016</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#2-0-0-whatcha-babbling-about-20-june-2016" data-ice="link">2.0.0 - Whatcha Babbling about? - 20 June 2016</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#1-1-0-wanna-catch-a-movie-20-march-2016" data-ice="link">1.1.0 - Wanna catch a movie? - 20 March 2016</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#1-0-2-wanna-retry-14-march-2016" data-ice="link">1.0.2 - Wanna retry? - 14 March 2016</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#1-0-1-what-s-trending-6-march-2016" data-ice="link">1.0.1 - What's trending? - 6 March 2016</a></li>
<li data-ice="manualNav" class="indent-h1"><span class="manual-dot"></span><a href="manual/changelog.html#1-0-0-let-s-kick-some-ass-1-march-2016" data-ice="link">1.0.0 - Let's kick some ass! - 1 March 2016</a></li>
</ul>
</div>
</div>
</nav>
<div class="content" data-ice="content"><div class="github-markdown">
<div class="manual-breadcrumb-list">
<a href="./manual/./index.html">Manual</a>
<span>»</span>
<span data-ice="title">Usage</span>
</div>
<div data-ice="content"><h1 id="usage">Usage</h1>
<p>In this usage section you can read about Popcorn API and its functionality through the CLI.</p>
<h2 id="npm">npm</h2>
<p>The following commands are defined in the <code>package.json</code>:</p>
<pre><code><code class="source-code prettyprint"> $ npm run start # Run Popcorn API and start the scraping process.
$ npm run start-dev # Same as above, but in development mode.
$ npm run server # Run Popcorn API, but do not start the scraping process.
$ npm run server-dev # Same as above, but in development mode.
$ npm run forever # Run Popcorn API with the 'forever' module.
$ npm run docs # Generate the documentation of the API.
$ npm run test # Execute the tests.
$ npm run coverage # Generate coverage with Coveralls.</code>
</code></pre><h2 id="gulp">Gulp</h2>
<p>The following commands are defined by Gulp:</p>
<pre><code><code class="source-code prettyprint"> $ gulp build # Transpile the ES6 source code to ES5.
$ gulp clean # Delete the 'build' directory.
$ gulp default # The default gulp task (same as 'gulp build').
$ gulp watch # Watch for any changes in the 'src' directory.</code>
</code></pre><h2 id="global">Global</h2>
<p>The following commands are available when Popcorn API is installed globally:</p>
<pre><code><code class="source-code prettyprint"> $ popcorn-api --content <type> # Add content to the database.
$ popcorn-api --run # Run Popcorn API and start the scraping process.
$ popcorn-api --server # Run Popcorn API, but do not start the scraping process.
$ popcorn-api --export <collection> # Export a collection to a JSON file.
$ popcorn-api --import <collection> # Import a collection file to the database.</code>
</code></pre></div>
</div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.4.8)</span></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>