mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-08 10:59:57 +00:00
af7b69e778
Now the link massager can control the HTML attributes of the link, and suppress it entirely if necessary. Using this new facility to generate a cleaner readme file for github
59 lines
3.7 KiB
Plaintext
59 lines
3.7 KiB
Plaintext
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.
|
|
|
|
The command line interface for TiddlyWiki5 has been designed to support two distinct usages:
|
|
* Cooking (or building) old 2.6.x versions of classic TiddlyWiki from the constituent JavaScript components
|
|
* Cooking and serving TiddlyWiki5 itself
|
|
|
|
!!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 state that is carried between options is as follows:
|
|
* The set of tiddlers that are currently loaded into memory
|
|
* The recipe file last used to load tiddlers (recipe files are used primarily to manage shadow tiddlers)
|
|
* The TiddlerFileStore used to store the main content tiddlers. This is independent of the current recipe
|
|
|
|
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 |
|
|
|`--store <dirpath>` |Load a specified TiddlerFileStore |
|
|
|`--links none` |Determines how links will be generated by subsequent options. See below for details |
|
|
|`--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 `--servetiddlers` 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.
|
|
|
|
`--links` controls the way that links are generated. Currently, the only option supported is:
|
|
|
|
`none`: Tiddler links are disabled
|
|
|
|
|