Angthing LLM for Tiddlywiki

 2nd August 2024 at 9:20am

Tiddlywiki5.1.23+
LicenseMIT
Release
Statusin progress

What is anythingllm?

AnythingLLM is the easiest to use, all-in-one AI application that can do RAG, AI Agents, and much more with no code or infrastructure headaches.

tw-anythingllm is TiddlyWiki interface for chatting for Anything LLM using API.

Tutorials

The tw-anythingllm Tutorial is the starting point to learn more about plugin features, help, demo and examples. See below for online pages.

Code and demo

History

Release 0.0.1

  • 2nd August, 2024
  • [NEW] First beta release

For all changes see ChangeLog

Install

From the below two categories of installing anythingllm plugin, select any suitable method you like.

It is highly recommended to backup your data before trying any new plugin! Do it before installing tw-anythingllm.

A. Installing plugin for Tiddlywiki single html file

Tiddlywiki as a single html file (like emtpy.html) is the most common form of Tiddlywiki in use. To install the plugin on a single html file, follow any of the below procedures.

I. Drag and drop

The simplest method, also called standalone configuration, is the drag and drop method.

  1. Open your Tiddlywiki in a browser
  2. Drag and drop $:/plugins/bangyou/tw-anythingllm into your wiki
  3. Save and reload your wiki

B. Installing plugin for Tiddlywiki on Node.js

III. Tiddlywiki + Node.js

There are two methods in which custom plugins that are not part of official Tiddlywiki's plugin library can be installed when using Tiddlywiki under Node.js (also called client-server configuration).

  • local installation in only a specific wiki
  • global installation on the server, so every wiki running on Node.js has access to the plugin

III.A Local installation

For local installation under Node.js
i. download the tw-anythingllm source folder from GitHub
ii. put the tw-anythingllm source folder directly into local plugins folder under your wiki folder,
iii. if you have not the plugins folder, create it under your own wiki folder.
iv. if server is runing, stop it and restart again
v. finished, it is now available in your wiki!

For details on how download a plugin from GitHub, see Downloading Plugin from GitHub

III.B Global installation

For global installation under Node.js

i. download the tw-anythingllm source folder from GitHub
ii. put the tw-anythingllm source folder into bangyou folder (publisher folder) under your server plugins folder
iii. if you have not the bangyou folder (publisher folder), create it under your server plugins folder
vi. finished installing for server!

Extra step for global installation (III.B)

After installing the a plugin globally in your Node.js server (the client-server configuration), to use it in any specific wiki, add it to the tiddlywiki.info file of that wiki:

  1. Open the specific wiki folder of choice
  2. Edit the tiddlywiki.info file (it is in JSON format) and locate the plugins section (see below)
  3. Add entries corresponding to the plugins you wish to use. Here add tw-anythingllm.
  4. Take care to retain commas to separate items, but do not terminate the last item in a list with a comma 

    {
	"plugins": [
		"tiddlywiki/codemirror",
		"bangyou/tw-anythingllm"
	],
  ...
}

  5. if server is runing, stop it and restart again

Detailed procedure can be found in More on Client-Server Installation

Code 
\import [[Plugin Data]]

\define output(p)
<$wikify text=<<__p__>> name=result mode=block output="html">
<<result>>
</$wikify>
\end


{{Plugin Status}}

<span style="float:right;width:72px">{{$:/favicon.ico}}</span>


!! What is <<plugindisplayName>>?
<<<
<$macrocall $name=find text={{{ [<pluginReadme>get[text]] }}} begin="
" end=";" mode="first" output="output"/>
<<<

!! Tutorials
>The [[tw-anythingllm Tutorial]] is the starting point to learn more about plugin features, help, demo and examples. See below for online pages.

!! Code and demo

* Demo: <<plugindemoUrl>>
* Code: <<plugincodeUrl>>

<$list filter="[tag[doc]tag[info]has[text]!has[draft.of]]">
<h2>{{!!title}}</h2>
<blockquote><$transclude tiddler=<<currentTiddler>> mode=block/></blockquote>
</$list>

tw-anythingllm Tutorial

 2nd August 2024 at 10:01am

Configure

Before usage, you can setup apikey for Anything LLM in this tiddler $:/config/anythingllm/apikey and host in $:/config/anythingllm/apikey.

Code 
<<tabs tabsList:"[tag[tutorial]!tag[advanced]sort[order]]" default:"Configure" class:"tc-vertical" template:"$:/tabs/tabTemplate" state:"$:/state/tab-tw-anythingllm-tutorial">>