2011-09-14 19:44:52 -04:00
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
|
|
|
<title>FileBot CLI</title>
|
|
|
|
|
<link rel="stylesheet" href="base.css" type="text/css" />
|
|
|
|
|
<link rel="stylesheet" href="code.css" type="text/css" />
|
|
|
|
|
<link rel="icon" href="favicon.png" />
|
|
|
|
|
|
2011-09-17 08:56:49 -04:00
|
|
|
<!-- google analytics -->
|
2011-09-14 19:44:52 -04:00
|
|
|
<script type="text/javascript">
|
2011-09-17 08:56:49 -04:00
|
|
|
var _gaq = _gaq || [];
|
|
|
|
|
_gaq.push(['_setAccount', 'UA-25379256-1']);
|
|
|
|
|
_gaq.push(['_trackPageview']);
|
|
|
|
|
|
|
|
|
|
(function() {
|
|
|
|
|
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
|
|
|
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
|
|
|
|
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
|
|
|
|
})();
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
<!-- google plus one -->
|
|
|
|
|
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
|
2011-09-14 19:44:52 -04:00
|
|
|
|
2011-09-17 08:56:49 -04:00
|
|
|
<!-- flattr -->
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
/* <![CDATA[ */
|
|
|
|
|
(function() {
|
|
|
|
|
var s = document.createElement('script'), t = document.getElementsByTagName('script')[0];
|
|
|
|
|
s.type = 'text/javascript';
|
|
|
|
|
s.async = true;
|
|
|
|
|
s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
|
|
|
|
|
t.parentNode.insertBefore(s, t);
|
|
|
|
|
})();
|
|
|
|
|
/* ]]> */
|
2011-09-14 19:44:52 -04:00
|
|
|
</script>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div class="page">
|
2011-09-17 08:56:49 -04:00
|
|
|
<div class="social">
|
|
|
|
|
<div class="plusone" style="display:inline; position:relative; left:25px; top:1px">
|
|
|
|
|
<g:plusone callback="_gaq.push(['_trackEvent','Social networking','Google Plus One',document.title])"></g:plusone>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="flattr" style="display:inline">
|
|
|
|
|
<a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://filebot.sourceforge.net"></a>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
2011-09-14 19:44:52 -04:00
|
|
|
<div class="header">
|
2011-09-17 08:56:49 -04:00
|
|
|
<a href="http://filebot.sourceforge.net"><img class="logo" alt="logo" src="images/icon.png" width="48" height="48" /></a>
|
2011-09-14 19:44:52 -04:00
|
|
|
<h1>
|
|
|
|
|
FileBot CLI
|
|
|
|
|
<span class="description">Command-line interface usage manual</span>
|
|
|
|
|
</h1>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="content">
|
|
|
|
|
<div class="screenshot" style="border:none; box-shadow:none; background:white">
|
2011-09-19 10:24:57 -04:00
|
|
|
<a target="_blank" href="screenshots/original/cli.png"><img alt="screenshot" src="screenshots/medium/cli.png" /></a>
|
|
|
|
|
</div>
|
2011-09-14 19:44:52 -04:00
|
|
|
<div class="section about">
|
|
|
|
|
<h2>About</h2>
|
|
|
|
|
<p>
|
|
|
|
|
FileBot can be called with set of command-line arguments directly from the console
|
|
|
|
|
or in scripts for automation running tasks like renaming
|
|
|
|
|
tv shows and movies, fetching subtitles or checking sfv files.
|
|
|
|
|
</p>
|
2011-09-22 12:11:00 -04:00
|
|
|
<h2 id="examples">Examples</h2>
|
2011-11-03 13:46:33 -04:00
|
|
|
<h3 id="rename">Rename</h3>
|
2011-09-14 19:44:52 -04:00
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">path/to/episodes</span></code>
|
2011-09-15 08:46:07 -04:00
|
|
|
Rename given episodes or movies.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"One Piece"</span> <span class="option">--db</span> <span class="argument">anidb</span></code>
|
2011-09-15 08:46:07 -04:00
|
|
|
Rename given episodes using AniDB episode info.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"Generation Kill"</span> <span class="option">--format</span> <span class="argument">"{n} E{e} [{t}]"</span> <span class="option">-non-strict</span></code>
|
2011-09-15 08:46:07 -04:00
|
|
|
Rename given episodes according to the given format. Enable comprehensive Episode/File matching.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"1x01.avi"</span> <span class="option">--q</span> <span class="argument">"Dexter"</span> <span class="option">--db</span> <span class="argument">thetvdb</span> <span class="option">--lang</span> <span class="argument">de</span></code>
|
2011-09-15 08:46:07 -04:00
|
|
|
Rename a single episode forcing the series name. Use German language episode info.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
|
|
|
|
<p>
|
2011-09-15 08:46:07 -04:00
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"movie.avi"</span> <span class="option">-q</span> <span class="argument">Avatar</span> <span class="option">--db</span> <span class="argument">OpenSubtitles</span></code>
|
|
|
|
|
Rename a single movie looking up movie info via file hash or using the given movie title.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
2011-11-03 13:46:33 -04:00
|
|
|
<h3 id="subtitles">Fetch Subtitles</h3>
|
2011-09-14 19:44:52 -04:00
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-get-subtitles</span> <span class="argument">path/to/episodes</span></code>
|
2011-09-15 08:46:07 -04:00
|
|
|
Fetch subtitles for the given files. Lookup matching subtitles via file hash.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-get-subtitles</span> <span class="argument">path/to/movie</span> <span class="option">--q</span> <span class="argument">Avatar</span> <span class="option">--lang</span> <span class="argument">zh</span> <span class="option">--output</span> <span class="argument">srt</span> <span class="option">--encoding</span> <span class="argument">utf8</span></code>
|
2011-09-15 08:46:07 -04:00
|
|
|
Fetch subtitles and force output format. Lookup subtitles via file hash and given search query.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
2011-11-03 13:46:33 -04:00
|
|
|
<h3 id="verification">File Verification</h3>
|
2011-09-14 19:44:52 -04:00
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-check</span> <span class="argument">path/to/files</span></code>
|
2011-09-15 08:46:07 -04:00
|
|
|
Compute SFV file and automatically determine output file.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-check</span> <span class="argument">path/to/files</span> <span class="option">--output</span> <span class="argument">checksum.md5</span></code>
|
2011-09-15 08:46:07 -04:00
|
|
|
Compute checksums according to the given output file.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-check</span> <span class="argument">path/to/checksum.md5</span></code>
|
2011-10-16 10:41:58 -04:00
|
|
|
Check file integrity using the given checksum file.
|
2011-09-14 19:44:52 -04:00
|
|
|
</p>
|
2011-11-03 13:46:33 -04:00
|
|
|
<h3 id="scripting">Scripting</h3>
|
2011-10-16 10:21:38 -04:00
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-list</span> <span class="option">--db</span> <span class="argument">thetvdb</span> <span class="option">--q</span> <span class="argument">Dexter</span> <span class="option">--format</span> <span class="argument">"{s}x{e.pad(2)} {t}"</span></code>
|
|
|
|
|
Fetch episode list and print to console.
|
|
|
|
|
</p>
|
2011-11-03 13:46:33 -04:00
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-mediainfo</span> <span class="argument">path/to/files</span> <span class="option">--format</span> <span class="argument">"{fn} {resolution} {vc} {af}"</span></code>
|
|
|
|
|
Read media info and print to console.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<code><span class="cmd">filebot</span> <span class="option">-script</span> <span class="argument">"path/to/script.groovy"</span> <span class="argument">args...</span></code>
|
2011-11-04 20:43:37 -04:00
|
|
|
Execute a given Groovy script. Find the manual on scripting <a href="script.html">here</a>.
|
2011-11-03 13:46:33 -04:00
|
|
|
</p>
|
2011-09-15 08:46:07 -04:00
|
|
|
|
2011-09-22 12:11:00 -04:00
|
|
|
<h2 class="reference" id="arguments">
|
2011-09-15 08:46:07 -04:00
|
|
|
Argument Reference
|
2011-11-04 20:43:37 -04:00
|
|
|
<a href="http://filebot.svn.sourceforge.net/viewvc/filebot/trunk/source/net/sourceforge/filebot/cli/ArgumentBean.java?view=markup" class="source" target="_blank">source</a>
|
2011-09-15 08:46:07 -04:00
|
|
|
</h2>
|
2011-09-15 05:51:22 -04:00
|
|
|
<table class="reference cli">
|
2011-09-17 08:56:49 -04:00
|
|
|
<tr>
|
|
|
|
|
<th>Name</th>
|
|
|
|
|
<th>Description</th>
|
|
|
|
|
<th>Usage</th>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>-rename</td>
|
|
|
|
|
<td>rename episode/movie files</td>
|
|
|
|
|
<td>media folder or episode/movie file</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>--db</td>
|
|
|
|
|
<td>episode/movie datasource</td>
|
|
|
|
|
<td>
|
|
|
|
|
<table>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>TV Series mode: TVRage, AniDB, TheTVDB</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>Movie mode: OpenSubtitles, TheMovieDB</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>--format</td>
|
2011-09-19 10:24:57 -04:00
|
|
|
<td><a href="naming.html">naming scheme</a></td>
|
|
|
|
|
<td><a href="naming.html">movie or episode format expression</a></td>
|
2011-09-17 08:56:49 -04:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>-non-strict</td>
|
|
|
|
|
<td>use less strict matching</td>
|
2011-09-22 08:24:10 -04:00
|
|
|
<td><small class="comment">(strict by default)</small></td>
|
2011-09-17 08:56:49 -04:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>-get-subtitles</td>
|
|
|
|
|
<td>fetch subtitles</td>
|
|
|
|
|
<td>media folder or episode/movie file</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>--q</td>
|
|
|
|
|
<td>search query</td>
|
|
|
|
|
<td>tv series or movie title</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>--lang</td>
|
2011-09-22 08:24:10 -04:00
|
|
|
<td><a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank">2-letter language code</a></td>
|
2011-09-17 08:56:49 -04:00
|
|
|
<td>en, de, fr, es, ja, zh, etc</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>-check</td>
|
|
|
|
|
<td>create/check verification file</td>
|
|
|
|
|
<td>folder or sfv file</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>--output</td>
|
|
|
|
|
<td>output format and/or path</td>
|
|
|
|
|
<td>
|
|
|
|
|
<table>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>Checksum mode: sfv, md5, sha1 or filename</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>Subtitle mode: srt <small class="comment">(re-encode subtitles in SubRip format)</small></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>--encoding</td>
|
|
|
|
|
<td>output charset</td>
|
|
|
|
|
<td>UTF-8, windows-1252, GB18030, etc</td>
|
|
|
|
|
</tr>
|
2011-10-16 10:41:58 -04:00
|
|
|
<tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>-list</td>
|
|
|
|
|
<td>print episode list</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
2011-11-03 13:46:33 -04:00
|
|
|
<tr>
|
|
|
|
|
<td>-mediainfo</td>
|
|
|
|
|
<td>print media info</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>-script</td>
|
|
|
|
|
<td><a href="script.html">execute script</a></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
2011-09-17 08:56:49 -04:00
|
|
|
<tr>
|
|
|
|
|
<td>--log</td>
|
|
|
|
|
<td>log level</td>
|
|
|
|
|
<td>all, config, info, warning</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>-clear</td>
|
2011-09-22 08:24:10 -04:00
|
|
|
<td>clear cache and preferences</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<td>-no-analytics</td>
|
|
|
|
|
<td>disable <a href="https://sourceforge.net/projects/filebot/forums/forum/723389/topic/4719727" target="_blank">analytics</a></td>
|
2011-09-17 08:56:49 -04:00
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2011-10-16 10:21:38 -04:00
|
|
|
<td>-help</td>
|
2011-09-17 08:56:49 -04:00
|
|
|
<td>print help message</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="footer" style="margin-top: 100px">
|
|
|
|
|
<div id="sflogo">
|
|
|
|
|
<a href="http://sourceforge.net/projects/filebot">
|
|
|
|
|
<img src="http://sflogo.sourceforge.net/sflogo.php?group_id=202747&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" />
|
|
|
|
|
</a>
|
|
|
|
|
</div>
|
|
|
|
|
Hosted on <a href="http://sourceforge.net">sourceforge.net</a>
|
|
|
|
|
| Creative Commons License: Attribution-NonCommercial-ShareAlike © 2011
|
2011-09-14 19:44:52 -04:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
