2011-11-27 00:32:06 -05:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" itemscope itemtype = "http://schema.org/Product" >
2011-09-14 19:44:52 -04:00
< head >
2011-11-27 00:32:06 -05:00
< meta http-equiv = "content-type" content = "text/html; charset=UTF-8" / >
2016-11-05 10:04:50 -04:00
< meta name = "keywords" content = "@{package.tags}" / >
2016-03-26 04:37:55 -04:00
2011-12-27 13:57:11 -05:00
< title > FileBot Command-line Interface< / title >
2011-12-25 12:17:49 -05:00
< meta name = "description" content = "The FileBot command-line interface will allow you to rename tv shows, download subtitles and do lots of other nifty things directly directly from the console. Running on an headless server is fully supported. Make sure to check out FileBot scripting as well for a new level of automation." / >
2016-03-26 04:37:55 -04:00
2011-12-25 12:17:49 -05:00
< meta itemprop = "name" content = "FileBot Command-line Interface" / >
< meta itemprop = "description" content = "The FileBot command-line interface will allow you to rename tv shows, download subtitles and do lots of other nifty things directly directly from the console. Running on an headless server is fully supported. Make sure to check out FileBot scripting as well for a new level of automation." / >
2016-11-05 10:04:50 -04:00
< meta itemprop = "image" content = "@{link.image.logo}" / >
2016-03-26 04:37:55 -04:00
2011-09-14 19:44:52 -04:00
< link rel = "stylesheet" href = "base.css" type = "text/css" / >
< link rel = "stylesheet" href = "code.css" type = "text/css" / >
< link rel = "icon" href = "favicon.png" / >
< / head >
< body >
< div class = "page" >
2011-12-10 04:59:27 -05:00
< div class = "navigation" >
2011-11-22 11:12:20 -05:00
< div >
< ul >
2016-11-26 00:17:57 -05:00
< li > < a href = "https://www.filebot.net/forums/" > Forums< / a > < / li >
< li > < a href = "https://www.filebot.net/forums/viewtopic.php?f=3&t=7" > FAQ< / a > < / li >
2015-06-01 15:26:44 -04:00
< li > < a href = "http://www.filebot.net/#download" > Download< / a > < / li >
2011-11-22 11:12:20 -05:00
< / ul >
< / div >
< / div >
2011-09-14 19:44:52 -04:00
< div class = "header" >
2015-06-01 15:26:44 -04:00
< a href = "http://www.filebot.net" > < img class = "logo" alt = "logo" src = "images/filebot.logo.svg" width = "64" height = "64" / > < / a >
2011-09-14 19:44:52 -04:00
< h1 >
FileBot CLI
< span class = "description" > Command-line interface usage manual< / span >
< / h1 >
< / div >
2016-03-26 04:37:55 -04:00
2011-09-14 19:44:52 -04:00
< div class = "content" >
2014-12-21 13:00:44 -05:00
< div class = "main-section-screenshot" >
2015-06-14 09:00:32 -04:00
< a target = "_blank" href = "screenshots/cli.png" > < img alt = "FileBot command-line tools" width = "330" height = "221" src = "screenshots/cli.png" / > < / a >
2011-09-19 10:24:57 -04:00
< / div >
2011-09-14 19:44:52 -04:00
< div class = "section about" >
< h2 > About< / h2 >
2013-10-30 17:33:18 -04:00
< p style = "width: 420px" >
2011-12-07 00:41:44 -05:00
FileBot can be called with a set of command-line arguments directly from the console
2013-10-30 17:33:18 -04:00
or in scripts for automation running tasks like renaming TV shows and movies, fetching subtitles or checking SFV files.
< / p >
< p style = "width: 420px" >
2016-11-26 00:17:57 -05:00
The CLI is designed for simple tasks. Please have a look at < a href = "script.html" > Scripts and Automation< / a > for something more powerful and find scripts for many common tasks < a href = "https://www.filebot.net/forums/viewtopic.php?f=4&t=5#p5" > here< / a > .
2011-09-14 19:44:52 -04:00
< / 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 >
2013-08-07 22:59:27 -04:00
< 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 > < span class = "option" > -non-strict< / span > < / code >
Rename given episodes using AniDB episode info. 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" > "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 >
2014-12-21 11:41:33 -05:00
< 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 >
2014-12-21 11:41:33 -05: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" > TheMovieDB< / span > < / code >
2011-09-15 08:46:07 -04:00
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 >
2012-02-22 03:19:49 -05:00
< p class = "suggestion" >
Keep in mind that the CLI is < strong > strict by default< / strong > so it will never mess up your files. In some cases you may need to enable < strong > -non-strict< / strong > for more opportunistic matching like the GUI does.
< / p >
2011-11-03 13:46:33 -04:00
< h3 id = "subtitles" > Fetch Subtitles< / h3 >
2011-09-14 19:44:52 -04:00
< p >
2016-05-09 03:42:38 -04:00
< code > < span class = "cmd" > filebot< / span > < span class = "option" > -get-subtitles< / span > < span class = "argument" > path/to/episodes< / span > < / code >
2011-11-28 08:09:10 -05:00
Fetch subtitles that are missing for the given files. Lookup matching subtitles via file hash only.
2011-09-14 19:44:52 -04:00
< / p >
< p >
2011-12-13 07:38:25 -05:00
< 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 > < span class = "option" > -non-strict< / span > < / code >
2011-11-28 08:09:10 -05:00
Fetch subtitles and force output format. Lookup subtitles via file hash or 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-12-13 07:38:25 -05:00
Compute checksums and write 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 >
2012-02-26 07:58:16 -05:00
< code > < span class = "cmd" > filebot< / span > < span class = "option" > -extract< / span > < span class = "argument" > "300.part01.rar"< / span > < span class = "option" > --output< / span > < span class = "argument" > path/to/folder< / span > < / code > < / code >
Extract files from single-volume or multi-volume archives (e.g. rar).
< / p >
< p >
2011-10-16 10:21:38 -04:00
< 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 >
2016-03-26 04:37:55 -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
2016-04-21 09:56:54 -04:00
< a href = "https://github.com/filebot/filebot/tree/master/source/net/filebot/cli/ArgumentBean.java" 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 >
2014-12-21 11:41:33 -05:00
< td > rename media files< / td >
< td > media folder or media file< / td >
< / tr >
2011-09-17 08:56:49 -04:00
< tr >
< td > --db< / td >
2016-03-26 04:37:55 -04:00
< td > database< / td >
2011-09-17 08:56:49 -04:00
< td >
< table >
< tr >
2016-03-26 04:37:55 -04:00
< td > Series mode: TheTVDB, AniDB< / td >
2014-12-21 11:41:33 -05:00
< / tr >
< tr >
< td > Movie mode: TheMovieDB, OMDb< / td >
2011-09-17 08:56:49 -04:00
< / tr >
< tr >
2016-03-28 16:45:43 -04:00
< td > Music mode: AcoustID, ID3< / td >
2011-09-17 08:56:49 -04:00
< / tr >
< / table >
< / td >
< / tr >
2012-02-20 10:40:49 -05:00
< tr >
< td > --order< / td >
< td > episode numbering< / td >
2012-03-08 00:11:06 -05:00
< td > airdate | absolute | dvd< / td >
2012-02-20 10:40:49 -05:00
< / tr >
2011-09-17 08:56:49 -04:00
< tr >
< td > --format< / td >
2011-09-19 10:24:57 -04:00
< td > < a href = "naming.html" > naming scheme< / a > < / td >
2016-03-26 04:37:55 -04:00
< td > < a href = "naming.html" > format expression< / a > < / td >
2011-09-17 08:56:49 -04:00
< / tr >
2012-03-08 00:11:06 -05:00
< tr >
< td > --action< / td >
< td > rename action< / td >
2016-05-20 11:27:39 -04:00
< td > move | copy | keeplink | symlink | hardlink | test< / td >
2012-03-08 00:11:06 -05:00
< / tr >
2012-03-10 05:24:35 -05:00
< tr >
< td > --conflict< / td >
< td > conflict resolution< / td >
2016-07-26 23:57:32 -04:00
< td > override | skip | auto | index | fail< / td >
2012-03-10 05:24:35 -05:00
< / tr >
2012-03-25 21:18:27 -04:00
< tr >
< td > --filter< / td >
2016-11-26 00:17:57 -05:00
< td > < a href = "https://www.filebot.net/forums/viewtopic.php?f=3&t=2127" target = "_blank" > match filter rules< / a > < / td >
2016-03-26 04:37:55 -04:00
< td > filter expression (e.g. < span style = "font-family: monospace; color: #008800" > y > 2000< / span > )< / td >
2012-03-25 21:18:27 -04:00
< / tr >
2011-09-17 08:56:49 -04:00
< tr >
< td > -get-subtitles< / td >
2011-11-28 08:09:10 -05:00
< td > fetch missing subtitles< / td >
2016-03-26 04:37:55 -04:00
< td > media folder or video file< / td >
2011-09-17 08:56:49 -04:00
< / tr >
< tr >
< td > --q< / td >
< td > search query< / td >
2016-03-26 04:37:55 -04:00
< td > force movie or series name< / td >
2011-09-17 08:56:49 -04:00
< / 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 >
2016-03-26 04:37:55 -04:00
< td > en, de, fr, es, ja, zh, ...< / td >
2011-09-17 08:56:49 -04:00
< / tr >
2011-11-25 14:43:24 -05:00
< tr >
< td > -non-strict< / td >
2016-03-26 04:37:55 -04:00
< td > opportunistic match mode< / td >
2011-11-25 14:43:24 -05:00
< td >
< table >
< tr >
2016-03-26 04:37:55 -04:00
< td > Rename mode: required for tricky filenames< / td >
2011-11-25 14:43:24 -05:00
< / tr >
< tr >
2016-11-26 00:17:57 -05:00
< td > Subtitle mode: < a href = "https://www.filebot.net/forums/viewtopic.php?f=3&t=2615" target = "_blank" > enable fuzzy search< / a > < / td >
2011-11-25 14:43:24 -05:00
< / tr >
< / table >
< / td >
< / tr >
2012-07-20 03:38:50 -04:00
< tr >
< td > -r< / td >
2016-03-26 04:37:55 -04:00
< td > traverse folders recursively< / td >
2012-07-20 03:38:50 -04:00
< td > < / td >
< / tr >
2011-09-17 08:56:49 -04:00
< tr >
< td > -check< / td >
2016-03-26 04:37:55 -04:00
< td > create or check sfv file< / td >
2011-09-17 08:56:49 -04:00
< td > folder or sfv file< / td >
< / tr >
2012-02-26 07:58:16 -05:00
< tr >
< td > -extract< / td >
< td > extract archives< / td >
< td > folder or archive file< / td >
< / tr >
2011-09-17 08:56:49 -04:00
< tr >
< td > --output< / td >
2014-12-21 11:41:33 -05:00
< td > output format or path< / td >
2011-09-17 08:56:49 -04:00
< td >
< table >
< tr >
2012-03-08 00:11:06 -05:00
< td > Rename mode: output folder< / td >
2011-09-17 08:56:49 -04:00
< / tr >
< tr >
2016-03-26 04:37:55 -04:00
< td > Subtitle mode: srt < small class = "comment" > (enable transcode non-srt subtitles)< / small > < / td >
2011-09-17 08:56:49 -04:00
< / tr >
2012-03-08 00:11:06 -05:00
< tr >
2016-03-26 04:37:55 -04:00
< td > Checksum mode: sfv, md5, sha256< / td >
2012-03-08 00:11:06 -05:00
< / tr >
2011-09-17 08:56:49 -04:00
< / table >
< / td >
< / tr >
< tr >
< td > --encoding< / td >
< td > output charset< / td >
2016-03-26 04:37:55 -04:00
< td > UTF-8, Windows-1252, GB18030, ...< / td >
2011-09-17 08:56:49 -04:00
< / tr >
2011-10-16 10:41:58 -04:00
< 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 >
2017-03-09 06:39:25 -05:00
< tr >
< td > --mode< / td >
< td > < a href = "https://www.filebot.net/forums/viewtopic.php?f=3&t=4398" > interactive< / a > < / td >
< td > < a href = "https://www.filebot.net/forums/viewtopic.php?f=3&t=4398" > enable console-interactive mode< / a > < / td >
< / tr >
2011-09-17 08:56:49 -04:00
< tr >
< td > --log< / td >
< td > log level< / td >
2016-10-19 13:01:47 -04:00
< td > ALL | FINE | INFO | WARNING< / td >
2011-09-17 08:56:49 -04:00
< / tr >
< tr >
2012-12-11 06:19:14 -05:00
< td > -clear-cache< / td >
< td > clear cache< / td >
2011-09-22 08:24:10 -04:00
< td > < / td >
< / tr >
2012-12-11 06:19:14 -05:00
< tr >
< td > -clear-prefs< / td >
< td > reset application settings< / td >
< td > < / td >
< / tr >
2016-03-26 04:37:55 -04:00
< tr >
< td > -no-xattr< / td >
< td > disable < a href = "https://en.wikipedia.org/wiki/Extended_file_attributes" target = "_blank" > extended attributes< / a > < / td >
< td > < / td >
< / tr >
< tr >
< td > -version< / td >
< td > print version< / td >
< td > < / td >
< / tr >
2011-09-17 08:56:49 -04:00
< tr >
2011-10-16 10:21:38 -04:00
< td > -help< / td >
2016-03-26 04:37:55 -04:00
< td > print usage< / td >
2011-09-17 08:56:49 -04:00
< td > < / td >
< / tr >
< / table >
< / div >
2016-03-26 04:37:55 -04:00
2011-11-26 22:53:23 -05:00
< p class = "suggestion" >
2016-11-26 00:17:57 -05:00
Need some help getting started? Check the < a href = "https://www.filebot.net/forums/viewforum.php?f=4" > forums< / a > .
2011-11-16 12:24:14 -05:00
< / p >
2016-03-26 04:37:55 -04:00
2011-11-26 22:53:23 -05:00
< div class = "metrics" >
< / div >
2016-03-26 04:37:55 -04:00
2011-11-26 22:53:23 -05:00
< div class = "footer" >
2016-08-04 11:44:27 -04:00
< p > Hosted on < a href = "http://sourceforge.net/projects/filebot/" > sourceforge.net< / a > | Creative Commons License: Attribution-NonCommercial-ShareAlike © @{tstamp.year}< / p >
2011-09-14 19:44:52 -04:00
< / div >
< / div >
< / div >
< / body >
< / html >
