TiddlyWiki5/tiddlywiki5/tiddlers/CommandLineInterface.tid

title: CommandLineInterface
modifier: JeremyRuston

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on RecipeFiles, TiddlerFiles and TiddlyWikiFiles.

Usage:
`
node tiddlywiki.js <options>
`
The command line options are processed sequentially from left to right. Processing pauses during long operations, like loading a [[recipe file|RecipeFiles]] and all the subrecipes and [[tiddlers|TiddlerFiles]] that it references, and then resumes with the next command line option in sequence. The following options are available:
|`--recipe <filepath>` |Loads a specfied `.recipe` file |
|`--load <filepath>` |Load additional tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files |
|`--savewiki <dirpath>` |Saves all the loaded tiddlers as a single file TiddlyWiki called `index.html` and an RSS feed called `index.xml` in a new directory of the specified name |
|`--savetiddler <title> <filename> [<type>]` |Save an individual tiddler as a specified MIME type, defaults to `text/html` |
|`--savetiddlers <outdir>` |Saves all the loaded tiddlers as `.tid` files in the specified directory |
|`--savehtml <outdir>` |Saves all the loaded tiddlers as static, unstyled `.html` files in the specified directory |
|`--servewiki <port>` |Serve the cooked TiddlyWiki over HTTP at `/` |
|`--servetiddlers <port>` |Serve individual tiddlers over HTTP at `/tiddlertitle` |
|`--wikitest <dir> [save]` |Run wikification tests against the tiddlers in the given directory. Include the `save` flag to save the test result files as the new targets |
|`--dumpstore` |Dump the TiddlyWiki store in JSON format |
|`--dumprecipe` |Dump the current recipe in JSON format |
|`--verbose` |verbose output, useful for debugging |
!! Examples
This example loads the tiddlers from a TiddlyWiki HTML file and makes them available over HTTP:
`
node tiddlywiki.js --load mywiki.html --servewiki 127.0.0.1:8000
`
This example cooks a TiddlyWiki from a recipe:
`
node tiddlywiki.js --recipe tiddlywiki.com/index.recipe --savewiki tmp/
`
This example ginsus a TiddlyWiki into its constituent tiddlers:
`
node tiddlywiki.js --load mywiki.html --savetiddlers tmp/tiddlers
`
!! Notes
`--servewiki` and `--servertiddlers` are for different purposes and should not be used together. The former is for TiddlyWiki core developers who want to be able to edit the TiddlyWiki source files in a text editor and view the results in the browser by clicking refresh; it is slow because it reloads all the TiddlyWiki JavaScript files each time the page is loaded. The latter is for experimenting with the new wikification engine.

`--wikitest` looks for `*.tid` files in the specified folder. It then wikifies the tiddlers to both "text/plain" and "text/html" format and checks the results against the content of the `*.html` and `*.txt` files in the same directory.
Content updates for TW5 2011-12-28 16:10:57 +00:00			`title: CommandLineInterface`
			`modifier: JeremyRuston`

			`TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on RecipeFiles, TiddlerFiles and TiddlyWikiFiles.`

			`Usage:`
Docs update 2012-01-23 16:42:23 +00:00			`
Content updates for TW5 2011-12-28 16:10:57 +00:00			`node tiddlywiki.js <options>`
Docs update 2012-01-23 16:42:23 +00:00			`
Docs update 2012-02-10 11:12:20 +00:00			`The command line options are processed sequentially from left to right. Processing pauses during long operations, like loading a [[recipe file\|RecipeFiles]] and all the subrecipes and [[tiddlers\|TiddlerFiles]] that it references, and then resumes with the next command line option in sequence. The following options are available:`
Docs update 2012-01-23 16:42:23 +00:00			\|`--recipe <filepath>` \|Loads a specfied `.recipe` file \|
			\|`--load <filepath>` \|Load additional tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files \|
			\|`--savewiki <dirpath>` \|Saves all the loaded tiddlers as a single file TiddlyWiki called `index.html` and an RSS feed called `index.xml` in a new directory of the specified name \|
			\|`--savetiddler <title> <filename> [<type>]` \|Save an individual tiddler as a specified MIME type, defaults to `text/html` \|
			\|`--savetiddlers <outdir>` \|Saves all the loaded tiddlers as `.tid` files in the specified directory \|
Docs updates 2012-03-03 18:06:24 +00:00			\|`--savehtml <outdir>` \|Saves all the loaded tiddlers as static, unstyled `.html` files in the specified directory \|
Docs update 2012-01-23 16:42:23 +00:00			\|`--servewiki <port>` \|Serve the cooked TiddlyWiki over HTTP at `/` \|
			\|`--servetiddlers <port>` \|Serve individual tiddlers over HTTP at `/tiddlertitle` \|
Added documentation for new flag for wikitest command line option 2012-03-30 12:46:26 +00:00			\|`--wikitest <dir> [save]` \|Run wikification tests against the tiddlers in the given directory. Include the `save` flag to save the test result files as the new targets \|
Docs update 2012-01-23 16:42:23 +00:00			\|`--dumpstore` \|Dump the TiddlyWiki store in JSON format \|
			\|`--dumprecipe` \|Dump the current recipe in JSON format \|
			\|`--verbose` \|verbose output, useful for debugging \|
Content updates for TW5 2011-12-28 16:10:57 +00:00			`!! Examples`
			`This example loads the tiddlers from a TiddlyWiki HTML file and makes them available over HTTP:`
Docs update 2012-01-23 16:42:23 +00:00			`
Content updates for TW5 2011-12-28 16:10:57 +00:00			`node tiddlywiki.js --load mywiki.html --servewiki 127.0.0.1:8000`
Docs update 2012-01-23 16:42:23 +00:00			`
Content updates for TW5 2011-12-28 16:10:57 +00:00			`This example cooks a TiddlyWiki from a recipe:`
Docs update 2012-01-23 16:42:23 +00:00			`
Content updates for TW5 2011-12-28 16:10:57 +00:00			`node tiddlywiki.js --recipe tiddlywiki.com/index.recipe --savewiki tmp/`
Docs update 2012-01-23 16:42:23 +00:00			`
Content updates for TW5 2011-12-28 16:10:57 +00:00			`This example ginsus a TiddlyWiki into its constituent tiddlers:`
Docs update 2012-01-23 16:42:23 +00:00			`
Content updates for TW5 2011-12-28 16:10:57 +00:00			`node tiddlywiki.js --load mywiki.html --savetiddlers tmp/tiddlers`
Docs update 2012-01-23 16:42:23 +00:00			`
Content updates for TW5 2011-12-28 16:10:57 +00:00			`!! Notes`
Docs update 2012-01-23 16:42:23 +00:00			`--servewiki` and `--servertiddlers` are for different purposes and should not be used together. The former is for TiddlyWiki core developers who want to be able to edit the TiddlyWiki source files in a text editor and view the results in the browser by clicking refresh; it is slow because it reloads all the TiddlyWiki JavaScript files each time the page is loaded. The latter is for experimenting with the new wikification engine.
New content 2012-01-15 11:46:20 +00:00
			`--wikitest` looks for `.tid` files in the specified folder. It then wikifies the tiddlers to both "text/plain" and "text/html" format and checks the results against the content of the `.html` and `*.txt` files in the same directory.