TiddlyWiki5/rabbithole/tw5.com/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 core/boot.js <options>
`
This boots the TiddlyWiki kernel and loads the core plugins. The wiki store is initially empty.

The command line options are processed sequentially from left to right. Processing pauses during long operations and then resumes with the next command line option in sequence.
ent recipe

The following options are available:
|`--load <filepath>` |Load tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files |
|`--savetiddler <title> <filename> [<type>]` |Save an individual tiddler as a specified MIME type, defaults to `text/html` |
|`--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 |
|`--dump tiddlers` |Dump the titles of the tiddlers in the wiki store |
|`--dump shadows` |Dump the titles of the shadow tiddlers in the wiki store |
|`--dump config` |Dump the current core configuration |
|`--verbose` |Triggers verbose output, useful for debugging |
!! Examples
This example loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:
`
node tiddlywiki.js --verbose --load mywiki.html --savertiddler ReadMe ./readme.html
`
!! Notes
`--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.
Introduce plugin module mechanism See the readme for details 2012-04-30 11:23:03 +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`
			`
Updated docs 2012-05-04 16:46:01 +00:00			`node core/boot.js <options>`
Introduce plugin module mechanism See the readme for details 2012-04-30 11:23:03 +00:00			`
Updated docs 2012-05-04 16:46:01 +00:00			`This boots the TiddlyWiki kernel and loads the core plugins. The wiki store is initially empty.`
Introduce plugin module mechanism See the readme for details 2012-04-30 11:23:03 +00:00
Updated docs 2012-05-04 16:46:01 +00:00			`The command line options are processed sequentially from left to right. Processing pauses during long operations and then resumes with the next command line option in sequence.`
			`ent recipe`
Introduce plugin module mechanism See the readme for details 2012-04-30 11:23:03 +00:00
			`The following options are available:`
Updated docs 2012-05-04 16:46:01 +00:00			\|`--load <filepath>` \|Load tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files \|
Introduce plugin module mechanism See the readme for details 2012-04-30 11:23:03 +00:00			\|`--savetiddler <title> <filename> [<type>]` \|Save an individual tiddler as a specified MIME type, defaults to `text/html` \|
			\|`--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 \|
Updated docs 2012-05-04 16:46:01 +00:00			\|`--dump tiddlers` \|Dump the titles of the tiddlers in the wiki store \|
			\|`--dump shadows` \|Dump the titles of the shadow tiddlers in the wiki store \|
			\|`--dump config` \|Dump the current core configuration \|
			\|`--verbose` \|Triggers verbose output, useful for debugging \|
Introduce plugin module mechanism See the readme for details 2012-04-30 11:23:03 +00:00			`!! Examples`
Updated docs 2012-05-04 16:46:01 +00:00			`This example loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:`
Introduce plugin module mechanism See the readme for details 2012-04-30 11:23:03 +00:00			`
Updated docs 2012-05-04 16:46:01 +00:00			`node tiddlywiki.js --verbose --load mywiki.html --savertiddler ReadMe ./readme.html`
Introduce plugin module mechanism See the readme for details 2012-04-30 11:23:03 +00:00			`
			`!! Notes`
			`--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.