<p>Welcome to <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a>, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.</p><p><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> is a complete interactive wiki in <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/JavaScript.html">JavaScript</a>. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/WikiText.html">WikiText</a>.</p><p>Learn more and see it in action at <aclass="tc-tiddlylink-external"href="https://tiddlywiki.com/"rel="noopener noreferrer"target="_blank">https://tiddlywiki.com/</a></p><p>Developer documentation is in progress at <aclass="tc-tiddlylink-external"href="https://tiddlywiki.com/dev/"rel="noopener noreferrer"target="_blank">https://tiddlywiki.com/dev/</a></p><h1class="">Installing <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><ol><li>Install <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Node.js.html">Node.js</a><ul><li>either from your favourite package manager: typically <code>apt-get install nodejs</code> on Debian/Ubuntu Linux or <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Serving%2520TW5%2520from%2520Android.html">Termux for Android</a>, or <code>brew install node</code> on a Mac</li><li>or directly from <aclass="tc-tiddlylink-external"href="http://nodejs.org"rel="noopener noreferrer"target="_blank">http://nodejs.org</a></li></ul></li><li>Open a command line terminal and type:<blockquote><p><code>npm install -g tiddlywiki</code></p><p>If it fails with an error you may need to re-run the command as an administrator:</p><p><code>sudo npm install -g tiddlywiki</code> (Mac/Linux)</p></blockquote></li><li>Check <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> is installed by typing:<blockquote><p><code>tiddlywiki --version</code></p></blockquote></li><li>In response, you should see <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> report its current version (eg "5.1.16"; you may also see other debugging information reported)</li><li>Try it out:<ol><li><code>tiddlywiki mynewwiki --init server</code> to create a folder for a new wiki that includes server-related components</li><li><code>tiddlywiki mynewwiki --server</code> to start <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a></li><li>Visit <aclass="tc-tiddlylink-external"href="http://127.0.0.1:8080/"rel="noopener noreferrer"target="_blank">http://127.0.0.1:8080/</a> in your browser</li><li>Try editing and creating tiddlers</li></ol></li><li>Optionally, make an offline copy:<ul><li>click the <svgclass="tc-image-save-button tc-image-button"height="22pt"viewBox="0 0 128 128"width="22pt">
</svg><strong>save changes</strong> button in the sidebar, <strong>OR</strong></li><li><code>tiddlywiki mynewwiki --build index</code></li></ul></li></ol><p>The <code>-g</code> flag causes <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> to be installed globally. Without it, <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> will only be available in the directory where you installed it.</p><p>If you are using Debian or Debian-based Linux and you are receiving a <code>node: command not found</code> error though node.js package is installed, you may need to create a symbolic link between <code>nodejs</code> and <code>node</code>. Consult your distro's manual and <code>whereis</code> to correctly create a link. See github <aclass="tc-tiddlylink-external"href="http://github.com/Jermolene/TiddlyWiki5/issues/1434"rel="noopener noreferrer"target="_blank">issue 1434</a></p><p>Example Debian v8.0: <code>sudo ln -s /usr/bin/nodejs /usr/bin/node</code></p><p>You can also install prior versions like this:</p><blockquote><p>npm install -g tiddlywiki@5.1.13</p></blockquote><h1class="">Using <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><p><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki5.html">TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWikiFolders.html">TiddlyWikiFolders</a>, <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlerFiles.html">TiddlerFiles</a> and <aclass="tc-tiddlylink tc-tiddlylink-missing"href="https://tiddlywiki.com/static/TiddlyWikiFiles.html">TiddlyWikiFiles</a>.</p><p>For example, the following command loads the tiddlers from a <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> HTML file and then saves one of them in static HTML:</p><pre><code>tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html</code></pre><p>Running <code>tiddlywiki</code> from the command line boots the <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.</p><p>The first argument is the optional path to the <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWikiFolders.html">TiddlyWikiFolder</a> to be loaded. If not present, then the current directory is used.</p><p>The commands and their individual arguments follow, each command being identified by the prefix <code>--</code>.</p><pre><code>tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]</code></pre><p>The available commands are:</p><p><ulclass="">
</ul></p><h1class="">Upgrading <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><p>If you've installed <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki%2520on%2520Node.js.html">TiddlyWiki on Node.js</a> on the usual way, when a new version is released you can upgrade it with this command:</p><pre><code>npm update -g tiddlywiki</code></pre><p>On Mac or Linux you'll need to add <strong>sudo</strong> like this:</p><pre><code>sudo npm update -g tiddlywiki</code></pre><h1class="">Also see</h1><p><ulclass="">
</ul></p><p><em>This readme file was automatically generated by <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a></em></p>
