SillyTavern

https://docs.sillytavern.app/
Admin
SillyTavern is a locally installed, open-source user interface that provides power users with...
Tokens:213,512
Snippets:2,026
Trust Score:7.2
Update:5 days ago
Show doc for...
Tokens:
Raw
### Start SillyTavern with command-line arguments

Source: https://docs.sillytavern.app/administration/config-yaml

Examples of how to pass port and network listening arguments when starting the server via node, npm, or the Windows batch file.

```shell
node server.js --port 8000 --listen false
# or
npm run start -- --port 8000 --listen false
# or (Windows only)
Start.bat --port 8000 --listen false
```

--------------------------------

### Enable modules with python server.py

Source: https://docs.sillytavern.app/extensions/extras/installation

Example command to start the Extras server with specific modules enabled. Ensure there are no spaces in the comma-separated module list.

```bash
python server.py --enable-modules=caption,summarize,classify
```

--------------------------------

### Clone and Launch SillyTavern Launcher

Source: https://docs.sillytavern.app/installation/windows

Run this command in the Command Prompt within your target installation folder to clone the launcher repository and start the installer.

```shell
git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher && start installer.bat
```

--------------------------------

### Install Dependencies

Source: https://docs.sillytavern.app/installation/android-%28termux%29

Install the necessary packages for running SillyTavern.

```bash
pkg install git nodejs-lts nano
```

--------------------------------

### Example /ask usage

Source: https://docs.sillytavern.app/usage/st-script

An example of using the /ask command to query a character named Alice.

```stscript
/ask name=Alice What is your favorite color?
```

--------------------------------

### Start SillyTavern Script

Source: https://docs.sillytavern.app/installation/linuxmacos

Commands to execute the start script.

```bash
./start.sh
```

```bash
bash start.sh
```

--------------------------------

### Start Extras server with selected modules

Source: https://docs.sillytavern.app/extensions/extras/installation

Command to start the Extras server using your specific module list. Replace YOUR,SELECTED,MODULE,LIST,HERE with your chosen modules.

```bash
python server.py --enable-modules=YOUR,SELECTED,MODULE,LIST,HERE
```

--------------------------------

### Navigate to Install Folder

Source: https://docs.sillytavern.app/installation/linuxmacos

Changes the current directory to the SillyTavern installation folder.

```bash
cd SillyTavern
```

--------------------------------

### Example /inject usage

Source: https://docs.sillytavern.app/usage/st-script

An example of using the /inject command with required and optional arguments.

```stscript
/inject id=IdGoesHere position=chat depth=4 My prompt injection
```

--------------------------------

### Macro Examples

Source: https://docs.sillytavern.app/usage/core-concepts/macros

Common examples of macros used to return user, character, time, and date information.

```text
{{user}}        // Returns the current user/persona name
{{char}}        // Returns the current character name
{{time}}        // Returns the current time
{{date}}        // Returns the current date
```

--------------------------------

### Mac Launcher Installation and Execution

Source: https://docs.sillytavern.app/installation/linuxmacos

Commands to install Homebrew, Git, and the SillyTavern launcher on MacOS.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

```bash
brew install git
```

```bash
git clone https://github.com/SillyTavern/SillyTavern-Launcher.git
```

```bash
cd SillyTavern-Launcher
```

```bash
chmod +x install.sh && ./install.sh
```

```bash
chmod +x launcher.sh && ./launcher.sh
```

--------------------------------

### Install Extras requirements

Source: https://docs.sillytavern.app/extensions/extras/installation

Install the necessary requirements for Extras. Choose one based on your feature needs.

```bash
pip install -r requirements.txt
```

```bash
pip install -r requirements-rvc.txt
```

```bash
pip install -r requirements-coqui.txt
```

--------------------------------

### Linux Launcher Installation and Execution

Source: https://docs.sillytavern.app/installation/linuxmacos

Commands to download, install, and launch SillyTavern using the launcher on Linux.

```bash
git clone https://github.com/SillyTavern/SillyTavern-Launcher.git
```

```bash
cd SillyTavern-Launcher
```

```bash
chmod +x install.sh && ./install.sh
```

```bash
chmod +x launcher.sh && ./launcher.sh
```

--------------------------------

### Install Git on Fedora/RHEL

Source: https://docs.sillytavern.app/installation/docker

Command to install Git on Fedora, RHEL, and similar distributions.

```sh
sudo dnf install git
```

--------------------------------

### Install Git via Winget

Source: https://docs.sillytavern.app/installation/windows

Run this command in the Run dialog box to install Git for Windows using the Windows Package Manager.

```shell
cmd /c winget install -e --id Git.Git
```

--------------------------------

### Run Extras with Summarize Module

Source: https://docs.sillytavern.app/extensions/summarize

Command to start the Extras server with the summarize module enabled.

```bash
python server.py --enable-modules=summarize
```

--------------------------------

### Hello World Plugin Example

Source: https://docs.sillytavern.app/for-contributors/server-plugins

A basic implementation of a server plugin showing how to register a route and export the required functions and metadata.

```javascript
/**
 * Initialize plugin.
 * @param {import('express').Router} router Express router
 * @returns {Promise<any>} Promise that resolves when plugin is initialized
 */
async function init(router) {
    // Do initialization here...
    router.get('/foo', req, res, function () {
       res.send('bar');
    });
    console.log('Example plugin loaded!');
    return Promise.resolve();
}

async function exit() {
    // Do some clean-up here...
    return Promise.resolve();
}

module.exports = {
    init,
    exit,
    info: {
        id: 'example',
        name: 'Example',
        description: 'My cool plugin!',
    },
};
```

--------------------------------

### Start XTTS Server

Source: https://docs.sillytavern.app/extensions/xtts

Launches the XTTS API server on the default host and port.

```bash
python -m xtts_api_server
```

--------------------------------

### Install Git on macOS

Source: https://docs.sillytavern.app/installation/docker

Command to install Git using Homebrew on macOS.

```sh
brew install git
```

--------------------------------

### Install ffmpeg on Linux

Source: https://docs.sillytavern.app/extensions/rvc

Use your distribution's package manager to install the required ffmpeg binary.

```shell
# Debian/Ubuntu
sudo apt install ffmpeg
# Arch Linux
sudo pacman -S ffmpeg
# Fedora
sudo dnf install ffmpeg
```

--------------------------------

### Space Separator Examples

Source: https://docs.sillytavern.app/usage/core-concepts/macros

Examples of macros using the space separator for arguments.

```text
{{getvar myVariable}}
{{roll 1d20}}
{{reverse Hello World}}
```

--------------------------------

### Run Extras with ChromaDB module

Source: https://docs.sillytavern.app/extensions/smart-context

Command to start the Extras server with the required chromadb module enabled.

```bash
python server.py --enable-modules=chromadb
```

--------------------------------

### Configuring TypeScript global.d.ts

Source: https://docs.sillytavern.app/for-contributors/writing-extensions

Create a global.d.ts file in your extension root to enable autocomplete for SillyTavern global objects. This example supports both user-scoped and server-scoped extension installations.

```typescript
export {};

// 1. Import for user-scoped extensions
import '../../../../public/global';
// 2. Import for server-scoped extensions
import '../../../../global';

// Define additional types if needed...
declare global {
    // Add global type declarations here
}
```

--------------------------------

### Start server with data root argument

Source: https://docs.sillytavern.app/installation/st-1.12.0-migration-guide

Use the --dataRoot console argument when starting the server to override the default data location.

```bash
node server.js --dataRoot="/Users/harry/ST-Data"
# OR
npm run start -- --dataRoot="/Users/harry/ST-Data"
```

--------------------------------

### Install ffmpeg on macOS

Source: https://docs.sillytavern.app/extensions/rvc

Install ffmpeg using the Homebrew package manager.

```shell
brew install ffmpeg
```

--------------------------------

### Test ffmpeg installation

Source: https://docs.sillytavern.app/extensions/rvc

Run this command in a command prompt to verify that ffmpeg is correctly installed and available in your system PATH.

```shell
ffmpeg
```

--------------------------------

### Run Extras again

Source: https://docs.sillytavern.app/extensions/extras/installation

Commands to activate the environment and start the Extras server for subsequent runs.

```bash
conda activate extras
python server.py
```

--------------------------------

### Launch KoboldCpp with LLaVA model and projections

Source: https://docs.sillytavern.app/extensions/captioning

Example command to load a multimodal-capable model and its corresponding projection weights using the --model and --mmproj flags.

```shell
./koboldcpp \
--model="models/llava-v1.5-7b-Q4_K.gguf" \
--mmproj="models/ llava-v1.5-7b-mmproj-Q4_0.gguf" \
... other flags ...
```

--------------------------------

### Install PyTorch with CUDA

Source: https://docs.sillytavern.app/extensions/xtts

Installs PyTorch with GPU acceleration support. Omit the index-url flag for CPU-only inference.

```bash
pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118
```

--------------------------------

### Start SillyTavern with Docker Compose

Source: https://docs.sillytavern.app/installation/docker

Run this command in the directory containing your docker-compose.yml file to pull the latest image and start the container.

```sh
docker compose up
```

--------------------------------

### System-wide install requirements

Source: https://docs.sillytavern.app/extensions/extras/installation

Install requirements using the system-wide Python pip module.

```bash
python -m pip install -r requirements.txt
```

--------------------------------

### Install Node.js LTS via winget on Windows

Source: https://docs.sillytavern.app/installation/updating/node

Use the Windows Package Manager in PowerShell to install the latest LTS version of Node.js.

```powershell
winget install --id=OpenJS.NodeJS.LTS  -e
```

--------------------------------

### Install XTTS Server Dependencies

Source: https://docs.sillytavern.app/extensions/xtts

Commands to install Python 3.10 and the required XTTS server packages.

```bash
conda install python=3.10
```

```bash
pip install xtts-api-server pydub
```

--------------------------------

### Start SillyTavern with TLS/SSL via CLI

Source: https://docs.sillytavern.app/usage/remoteconnections

Use the --ssl flag to enable encryption for your SillyTavern instance.

```bash
node server.js --ssl
```

--------------------------------

### Install hnswlib via Conda

Source: https://docs.sillytavern.app/extensions/extras/installation

Use conda to install hnswlib if you encounter wheel building errors when installing ChromaDB.

```bash
conda install -c conda-forge hnswlib
```

--------------------------------

### Install wxpython for Linux

Source: https://docs.sillytavern.app/extensions/extras/installation

Install the wxpython package manually on Linux to resolve 'talkinghead' module import errors.

```bash
pip install wxpython
```

--------------------------------

### Initialize XTTS Server Environment

Source: https://docs.sillytavern.app/extensions/xtts

Commands to navigate to the installation directory, create a conda environment, and activate it.

```bash
cd C:\xtts
```

```bash
conda create -n xtts
```

```bash
conda activate xtts
```

--------------------------------

### Install Git on Debian

Source: https://docs.sillytavern.app/installation/docker

Command to install Git on Debian-based distributions like Ubuntu or Pop! OS.

```sh
sudo apt install git
```

--------------------------------

### Legacy whitelist.txt configuration

Source: https://docs.sillytavern.app/usage/remoteconnections

Example content for the optional whitelist.txt file. Note that config.yaml is preferred over this method.

```text

10.0.0.0/8
172.16.0.0/12
192.168.0.0/16
127.0.0.1
::1

```

--------------------------------

### Start server with .env file

Source: https://docs.sillytavern.app/administration/config-yaml

Use the --env-file flag to load environment variables from a file when running on Node.js v20 or later.

```bash
node --env-file=.env server.js
```

--------------------------------

### Start SillyTavern with Custom Certificate Paths

Source: https://docs.sillytavern.app/usage/remoteconnections

Specify custom locations for your private key and certificate files using the --keyPath and --certPath arguments.

```bash
node server.js --ssl --keyPath /home/user/certificates/privkey.pem --certPath /home/user/certificates/cert.pem
```

--------------------------------

### STScript /while Loop Example

Source: https://docs.sillytavern.app/usage/st-script

This example increments a variable 'i' until it reaches 10, then outputs the result.

```stscript

/setvar key=i 0 |
/while left=i right=10 rule=lt "/addvar key=i 1" |
/echo {{getvar::i}} |
/flushvar i

```

--------------------------------

### Install esbuild for 32-bit Android

Source: https://docs.sillytavern.app/installation/android-%28termux%29

Required dependency for 32-bit Android systems that cannot be installed via npm.

```bash
pkg install esbuild
```

--------------------------------

### Single Colon Legacy Examples

Source: https://docs.sillytavern.app/usage/core-concepts/macros

Example of the legacy single colon syntax.

```text
{{roll:1d20}}
```

--------------------------------

### Run and Update SillyTavern

Source: https://docs.sillytavern.app/installation/android-%28termux%29

Commands to start the application or update the local repository.

```bash
cd ~/SillyTavern
bash start.sh
```

```bash
cd ~/SillyTavern
git pull --rebase --autostash
```

--------------------------------

### Example settings.html template file

Source: https://docs.sillytavern.app/for-contributors/writing-extensions

A sample Handlebars template file used for extension settings, utilizing data-i18n attributes for localization.

```html
<div class="my-extension-settings">
    <div class="inline-drawer">
        <div class="inline-drawer-toggle inline-drawer-header">
            <b data-i18n="{{title}}">{{title}}</b>
            <div class="inline-drawer-icon fa-solid fa-circle-chevron-down down"></div>
        </div>
        <div class="inline-drawer-content">
            <label for="my_ext_option">
                <span data-i18n="Option">Option</span>
            </label>
            <input id="my_ext_option" type="text" value="{{defaultValue}}" />
        </div>
    </div>
</div>
```

--------------------------------

### Install Git on Arch Linux

Source: https://docs.sillytavern.app/installation/docker

Command to install Git on Arch Linux-based distributions like Manjaro or EndeavourOS.

```sh
sudo pacman -S git
```

--------------------------------

### Nested Macro Example

Source: https://docs.sillytavern.app/usage/core-concepts/macros

Demonstrates nesting macros where the inner macro resolves first.

```text
{{getvar::{{char}}_mood}}
```

--------------------------------

### Start SillyTavern with Docker Compose

Source: https://docs.sillytavern.app/installation/docker

Command to start the SillyTavern container in detached mode within the docker folder.

```sh
docker compose up -d
```

--------------------------------

### /trimstart

Source: https://docs.sillytavern.app/usage/st-script

Trims the input to the start of the first complete sentence and outputs the result to the pipe.

```APIDOC
## /trimstart

### Description
Trims the input to the start of the first complete sentence and outputs the result to the pipe.

### Usage
```
/trimstart (input)
```

### Arguments
- **Unnamed argument** (string) - Optional - The input text to be trimmed.

### Output
Outputs the trimmed text to the pipe.
```

--------------------------------

### Double Colon Separator Examples

Source: https://docs.sillytavern.app/usage/core-concepts/macros

Examples of macros using the double colon separator for multiple arguments.

```text
{{setvar::myVariable::Hello World}}
{{random::red::green::blue}}
{{roll::2d6+3}}
```

--------------------------------

### Clone Oobabooga Repository

Source: https://docs.sillytavern.app/usage/how-to-use-a-self-hosted-model

The initial step to install the text-generation-webui by cloning the repository.

```bash
git clone https://github.com/oobabooga/text-generation-webui
```

--------------------------------

### List of folders and files to migrate

Source: https://docs.sillytavern.app/installation/updating

A list of specific folders and files from the /public directory that should be copied to the new installation's /data/default-user folder.

```plaintext
Assets
Backgrounds
Characters
Chats
Context
Groups
Group chats
Instruct
movingUI
KoboldAI Settings
NovelAI Settings
OpenAI Settings
QuickReplies
TextGen Settings (textgen = ooba)
Themes
User Avatars
Worlds
User
settings.json
secrets.json <---- this one is in the base folder, not /public/
```

--------------------------------

### Example of nested protocol configuration

Source: https://docs.sillytavern.app/administration/config-yaml

Demonstrates the use of YAML hierarchy to set the ipv6 protocol option to false.

```yaml
protocol:
  ipv6: false
```

--------------------------------

### Install system packages via Conda

Source: https://docs.sillytavern.app/extensions/extras/installation

Install Python 3.11 and git within the active Conda environment.

```bash
conda install python=3.11 git
```

--------------------------------

### Run SillyTavern in Global Mode via npm

Source: https://docs.sillytavern.app/installation

Use the start:global script defined in the package.json file.

```bash
npm run start:global
```

--------------------------------

### Enable classify module in Extras

Source: https://docs.sillytavern.app/extensions/expression-images

Start the Extras server with the classify module enabled.

```bash
python server.py --enable-modules=classify
```

--------------------------------

### Install Python Environment via Conda

Source: https://docs.sillytavern.app/extensions/talkinghead

Commands to create and activate a Conda environment and install the necessary dependencies for the Talking Head extension.

```bash
conda create -n talking-head-anime-3-demo python=3.8 conda activate talking-head-anime-3-demo conda install pytorch torchvision torchaudio cudatoolkit=11.3 -c pytorch conda install scipy pip install wxpython conda install matplotlib
```

--------------------------------

### Run Docker Compose

Source: https://docs.sillytavern.app/usage/st-reverse-proxy-guide

Commands to navigate to the docker directory and start the containers in detached mode.

```bash
cd /docker
docker compose up -d
```

--------------------------------

### Debugger breakpoint example

Source: https://docs.sillytavern.app/usage/st-script

Demonstrates using the /breakpoint command to pause script execution for inspection within the Quick Reply editor.

```stscript

/let x {: n=1
	/echo n is {{var::n}} |
	/mul n n |
:} |
/breakpoint |
/:x n=3 |
/echo result is {{pipe}} |

```

--------------------------------

### Example Script for Variable Usage

Source: https://docs.sillytavern.app/usage/st-script

This script demonstrates capturing user input into a local variable, echoing it back, and passing it to the /imagine command.

```stscript
/input What do you want to generate? |
/setvar key=SDinput |
/echo Requesting an image of {{getvar::SDinput}} |
/getvar SDinput |
/imagine
```

--------------------------------

### Restart SillyTavern Container

Source: https://docs.sillytavern.app/usage/st-reverse-proxy-guide

Start the SillyTavern container again after updating the configuration.

```bash
docker compose up -d sillytavern
```

--------------------------------

### Install SillyTavern-extras RVC requirements

Source: https://docs.sillytavern.app/extensions/rvc

Installs the required Python packages for RVC support in SillyTavern-extras. Run from the SillyTavern-extras directory.

```shell
pip install -r requirements-rvc.txt`
```

--------------------------------

### ChromaDB installation error message

Source: https://docs.sillytavern.app/extensions/smart-context

Error message encountered when the hnswlib dependency fails to build during ChromaDB installation.

```text
ERROR: Could not build wheels for hnswlib, which is required to install pyproject.toml-based projects
```

--------------------------------

### Create a Windows Batch File for Extras Startup

Source: https://docs.sillytavern.app/extensions/extras/installation

Create a .bat file to automate the startup process for SillyTavern Extras on Windows. Replace the placeholder paths and module list with your specific configuration.

```batch
cd C:\_your_\_full_\_Extras_\_folder_\_path_\
call conda activate extras
python server.py --enable-modules=YOUR,SELECTED,MODULE,LIST,HERE,WITH,NO,SPACES
call conda deactivate
pause
```

--------------------------------

### Get last N messages using variables

Source: https://docs.sillytavern.app/usage/st-script

This example demonstrates how to calculate a range dynamically using variable subtraction to retrieve the last 3 messages in a chat.

```stscript

/setvar key=start {{lastMessageId}} |
/addvar key=start -2 |
/messages names=off {{getvar::start}}-{{lastMessageId}} |
/setinput

```

--------------------------------

### Run Docker command with sudo

Source: https://docs.sillytavern.app/installation/updating

Example of prefixing a docker command with sudo to resolve permission denied errors.

```bash
sudo docker compose down
```

--------------------------------

### Run a simplified Hello World script with /echo

Source: https://docs.sillytavern.app/usage/st-script

A more concise version of the Hello World script, demonstrating that constant unnamed arguments can be passed directly to commands.

```stscript
/echo Hello, World!
```

--------------------------------

### Variable Macro Substitution Example

Source: https://docs.sillytavern.app/usage/st-script

Shows the default behavior of variable substitution.

```stscript
// the following will echo the last message's id / number |
/setvar key=x {{lastMessageId}} |
/echo {{getvar::x}}
```

--------------------------------

### Update Node.js with nvm-windows

Source: https://docs.sillytavern.app/installation/updating/node

Use these commands to install and switch to the latest LTS version of Node.js using nvm-windows.

```bash
nvm install lts
nvm use lts
```

--------------------------------

### Run manual_poser Desktop Application

Source: https://docs.sillytavern.app/extensions/talkinghead

Commands to activate the environment and launch the manual_poser application from the repository root.

```bash
python tha3/app/manual_poser.py
```

```bash
conda activate extras
```

--------------------------------

### Start rvc-python API server

Source: https://docs.sillytavern.app/extensions/rvc

Starts the rvc-python API server on port 5050, listening on all interfaces, with models from the 'models_path' directory. Remove '-l' to listen only on localhost, and remove '-md models_path' to use the default 'rvc_models' directory.

```shell
python -m rvc_python api -p 5050 -l -md models_path
```

--------------------------------

### Importing functions from SillyTavern scripts

Source: https://docs.sillytavern.app/for-contributors/writing-extensions

Example of importing a function from a local script file to generate a reply in the background.

```javascript
import { generateQuietPrompt } from "../../../../script.js";

async function handleMessage(data) {
    const text = data.message;
    const translated = await generateQuietPrompt({ quietPrompt: text });
    // ...
}
```

--------------------------------

### Run a Hello World script with /pass and /echo

Source: https://docs.sillytavern.app/usage/st-script

This script demonstrates the use of the /pass command to write a value to the pipe and the /echo command to display it as a toast notification.

```stscript
/pass Hello, World! | /echo
```

--------------------------------

### Run SillyTavern with Docker CLI

Source: https://docs.sillytavern.app/installation/docker

Execute this command to start the container with custom volume mappings for configuration, data, plugins, and extensions, as well as a specified public port.

```bash
SILLYTAVERN_VERSION="latest"
PUBLIC_PORT="8000"
CONFIG_PATH="./config"
DATA_PATH="./data"
PLUGINS_PATH="./plugins"
EXTENSIONS_PATH="./extensions"

docker run \
  --name="sillytavern" \
  -p "$PUBLIC_PORT:8000/tcp" \
  -v "$CONFIG_PATH:/home/node/app/config:rw" \
  -v "$DATA_PATH:/home/node/app/data:rw" \
  -v "$EXTENSIONS_PATH:/home/node/app/public/scripts/extensions/third-party:rw" \
  -v "$PLUGINS_PATH:/home/node/app/plugins:rw" \
  ghcr.io/sillytavern/sillytavern:"$SILLYTAVERN_VERSION"
```

--------------------------------

### Local connection console log

Source: https://docs.sillytavern.app/usage/remoteconnections

Example of a console message when a browser connects from the same machine as the server.

```text

New connection from 127.0.0.1; User Agent: ...

```

--------------------------------

### Scoped Content Trimming Example

Source: https://docs.sillytavern.app/usage/core-concepts/macros

Demonstrates how scoped content is automatically de-dented.

```text
{{ if condition }}
    # Heading
    Some content here
{{ /if }}
```

--------------------------------

### Implementation of Hook Functions

Source: https://docs.sillytavern.app/for-contributors/writing-extensions

Example of exporting hook functions from the extension's main JS entry point. Each function receives no arguments and can optionally return a Promise.

```APIDOC
## Implementation of Hook Functions

### Description
Export the hook functions from your main JS entry point. Each function receives no arguments and can optionally return a Promise.

### Example
```javascript
// index.js - your extension's entry point

export async function onInstall() {
    console.log('Extension installed! Performing first-time setup...');
    // e.g., initialize default data, create storage entries
}

export async function onActivate() {
    console.log('Extension activated during page load');
}

export async function onUpdate() {
    console.log('Extension updated! Running migrations...');
    // e.g., migrate data from old format to new format
}

export async function onDelete() {
    console.log('Extension about to be deleted. Cleaning up...');
    // e.g., remove stored data, clean up localStorage
    const { localforage } = SillyTavern.libs;
    await localforage.removeItem('my_extension_data');
}

export function onEnable() {
    console.log('Extension enabled');
}

export function onDisable() {
    console.log('Extension disabled');
}

export async function onClean() {
    console.log('Extension data cleaned');
    // e.g., cleanup of the extension's data here
}
```

### Notes
- Hook functions have a 5-second timeout. If a hook takes longer, execution continues and a warning is logged.
- Keep hook logic fast and lightweight.
```

--------------------------------

### Defining and calling procedures

Source: https://docs.sillytavern.app/usage/st-script

Example of creating a 'GetRandom' procedure and a 'GetMessage' script that calls it to display a result.

```stscript

/pass {{roll:d100}}

```

```stscript

/run GetRandom | /echo Your lucky number is: {{pipe}}

```

--------------------------------

### Update Node.js with nvm on Unix/Linux/macOS

Source: https://docs.sillytavern.app/installation/updating/node

Use these commands to install and switch to the latest LTS version of Node.js using nvm on Unix-based systems.

```bash
nvm install --lts
nvm use --lts
```

--------------------------------

### Example database memory string

Source: https://docs.sillytavern.app/extensions/smart-context

A sample chat message string used to illustrate how the Individual Memory Length setting affects message truncation.

```text
Ross: I like dogs with long fur and fluffy tails. I dislike dogs with short fur and short tails.
```

--------------------------------

### Get Variable Shorthand

Source: https://docs.sillytavern.app/usage/core-concepts/macros

Retrieve local or global variable values using the . or $ prefix.

```text
{{.myvar}}       // Get local variable "myvar"
{{$myvar}}       // Get global variable "myvar"
```

--------------------------------

### Translation JSON entry

Source: https://docs.sillytavern.app/for-contributors/i18n

Example of the translation entry for Generate Image in the language file.

```json
{
    "Generate Image": "生成图片"
}
```

--------------------------------

### Manual execution script example

Source: https://docs.sillytavern.app/usage/st-script

A script that increments a 'clicks' variable and displays a message upon reaching 5 clicks, then resets the variable.

```stscript

/addvar key=clicks 1 |
/if left=clicks right=5 rule=eq else="/echo Keep going..." "/echo You did it!  \| /flushvar clicks"

```

--------------------------------

### Check current Node.js version

Source: https://docs.sillytavern.app/installation/updating/node

Run this command in your terminal or command prompt to verify the installed version of Node.js.

```bash
node -v
```

--------------------------------

### Forbidden connection attempt console log

Source: https://docs.sillytavern.app/usage/remoteconnections

Example of a console message when a connection is refused due to whitelist restrictions.

```text

New connection from 192.168.116.211; User Agent: ...

Forbidden: Connection attempt from 192.168.116.211. If you are attempting to connect, 
please add your IP address in whitelist or disable whitelist mode in config.yaml in 
root of SillyTavern folder.

```

--------------------------------

### Combined Macro Flags

Source: https://docs.sillytavern.app/usage/core-concepts/macros

Example showing that multiple flags can be combined within a single macro tag.

```text
{{!?macroName}}
```

--------------------------------

### Configure healthcheck in docker-compose.yml

Source: https://docs.sillytavern.app/installation/docker

Example configuration for the SillyTavern service in docker-compose.yml, including the heartbeat interval and healthcheck parameters.

```yaml
services:
  sillytavern:
    environment:
      - SILLYTAVERN_HEARTBEATINTERVAL=30
    healthcheck:
      test: ["CMD", "node", "src/healthcheck.js"]
      interval: 30s
      timeout: 10s
      start_period: 20s
      retries: 3
```

--------------------------------

### Conditional user input evaluation

Source: https://docs.sillytavern.app/usage/st-script

An example demonstrating how to capture user input and execute different commands based on the input value.

```stscript
/input What's your favorite drink? |
/if left={{pipe}} right="black tea" rule=eq else={: /echo You shall not pass | /abort :} {: /echo Welcome to the club, {{user}} :}
```

--------------------------------

### PresetManager: writePresetExtensionField and readPresetExtensionField

Source: https://docs.sillytavern.app/for-contributors/writing-extensions

Shows how to get the PresetManager instance and use its methods to write and read extension data in settings presets.

```APIDOC
## PresetManager: writePresetExtensionField and readPresetExtensionField

### Description
These methods allow extensions to store and retrieve arbitrary JSON data in the settings presets of supported API types. The data is exported and imported with the preset JSON.

### Methods

#### writePresetExtensionField

Writes a value to a specified path in the preset extension field.

##### Parameters
- **path** (string) - Required - The path to the field in the preset data.
- **value** (any) - Required - The value to write.
- **name** (string) - Optional - The name of the preset to write to. Defaults to the currently selected preset.

##### Example
```javascript
await pm.writePresetExtensionField({ path: 'hello', value: 'world' });
```

#### readPresetExtensionField

Reads a value from a specified path in the preset extension field.

##### Parameters
- **path** (string) - Required - The path to the field in the preset data.
- **name** (string) - Optional - The name of the preset to read from. Defaults to the currently selected preset.

##### Returns
- The value stored at the given path.

##### Example
```javascript
const value = pm.readPresetExtensionField({ path: 'hello' });
```

### Notes
- The PresetManager instance is obtained via `SillyTavern.getContext().getPresetManager()`.
- The `PRESET_CHANGED` and `MAIN_API_CHANGED` events are emitted when the preset is changed or the main API is switched.
```

--------------------------------

### Clone RVC Easy Menu Repository

Source: https://docs.sillytavern.app/extensions/rvc

Clone the RVC Easy Menu repository to your local machine to begin the installation process.

```shell
git clone https://github.com/deffcolony/rvc-easy-menu.git
```

--------------------------------

### Listen to events with eventSource.on

Source: https://docs.sillytavern.app/for-contributors/writing-extensions

Use the eventSource.on method to register a handler for specific event types. The example demonstrates listening for the MESSAGE_RECEIVED event.

```javascript
const { eventSource, event_types } = SillyTavern.getContext();

eventSource.on(event_types.MESSAGE_RECEIVED, handleIncomingMessage);

function handleIncomingMessage(data) {
    // Handle message
}
```

--------------------------------

### Run SillyTavern-extras with RVC and classify modules

Source: https://docs.sillytavern.app/extensions/rvc

Enables both RVC and classify modules for expression-based dynamic voice. The remaining setup is similar to using RVC alone.

```shell
python server.py --enable-modules=rvc,classify
```

--------------------------------

### Create CF_DNS_API_KEY file

Source: https://docs.sillytavern.app/usage/st-reverse-proxy-guide

Command to navigate to the secrets directory and create the API key file.

```bash
cd secrets/cloudflare
nano CF_DNS_API_KEY
```

--------------------------------

### Set environment variables via command line

Source: https://docs.sillytavern.app/administration/config-yaml

Pass environment variables directly to the server process at startup.

```bash
SILLYTAVERN_LISTEN=true SILLYTAVERN_PORT=8000 node server.js
```

--------------------------------

### Executing Quick Replies

Source: https://docs.sillytavern.app/usage/st-script

Using /: as a shorthand for /run to execute Quick Replies.

```stscript
/:QrSetName.QrButtonLabel |
/run QrSetName.QrButtonLabel
```

--------------------------------

### /qr-create

Source: https://docs.sillytavern.app/usage/st-script

Creates a new Quick Reply with specified arguments and an optional message.

```APIDOC
## /qr-create

### Description
Creates a new Quick Reply with the given arguments and optional message.

### Method
Slash Command

### Endpoint
/qr-create (arguments, [message])

### Parameters
#### Arguments
- **label** (string) - Required - Text on the button, e.g., label=MyButton
- **set** (string) - Required - Name of the QR set, e.g., set=PresetName1
- **hidden** (bool) - Optional - Whether the button should be hidden, e.g., hidden=true
- **startup** (bool) - Optional - Auto execute on app startup, e.g., startup=true
- **user** (bool) - Optional - Auto execute on user message, e.g., user=true
- **bot** (bool) - Optional - Auto execute on AI message, e.g., bot=true
- **load** (bool) - Optional - Auto execute on chat load, e.g., load=true
- **title** (bool) - Optional - Title / tooltip to be shown on button, e.g., title="My Fancy Button"

### Request Example
/qr-create set=MyPreset label=MyButton /echo 123

```

--------------------------------

### Insert message at specific position

Source: https://docs.sillytavern.app/usage/st-script

The /send command supports an optional 'at' argument to specify the zero-based index for message insertion. This example inserts a message at the beginning of the chat history.

```stscript

/send at=0 Hi, I use Linux.

```

--------------------------------

### Create Docker root directory

Source: https://docs.sillytavern.app/usage/st-reverse-proxy-guide

Initializes the root docker directory.

```bash
cd /
sudo mkdir docker && cd docker
```

--------------------------------

### Update Termux

Source: https://docs.sillytavern.app/installation/android-%28termux%29

Update and upgrade installed Termux packages.

```bash
pkg update && pkg upgrade
```

--------------------------------

### /qr-presetupdate and /qr-presetadd

Source: https://docs.sillytavern.app/usage/st-script

Creates or updates a Quick Reply preset with specified arguments.

```APIDOC
## /qr-presetupdate and /qr-presetadd

### Description
Creates or updates a Quick Reply preset. /qr-presetadd creates a new preset (overrides existing ones), while /qr-presetupdate updates an existing preset.

### Method
Slash Command

### Endpoint
/qr-presetupdate (arguments [label]) or /qr-presetadd (arguments [label])

### Parameters
#### Arguments
- **enabled** (bool) - Optional - Enable or disable the preset
- **nosend** (bool) - Optional - Disable send / insert in user input (invalid for slash commands)
- **before** (bool) - Optional - Place QR before user input
- **slots** (int) - Optional - Number of slots
- **inject** (bool) - Optional - Inject user input automatically (if disabled use {{input}})

### Request Example
/qr-presetadd slots=3 MyNewPreset

```

--------------------------------

### User input and echo command

Source: https://docs.sillytavern.app/usage/st-script

Demonstrates using /input to capture user text and /echo to display it using the {{pipe}} macro.

```stscript
/input Enter your name |
/echo Hello, my name is {{pipe}}
```

--------------------------------

### Escape Closure Delimiters

Source: https://docs.sillytavern.app/usage/st-script

Escape closure start and end sequences with a single backslash.

```stscript
/echo {: |
/echo :}
```

--------------------------------

### Create Quick Reply

Source: https://docs.sillytavern.app/usage/st-script

Creates a new Quick Reply using the /qr-create command.

```text
/qr-create set=MyPreset label=MyButton /echo 123
```

--------------------------------

### Enable SillyTavern Listen Mode and Basic Auth

Source: https://docs.sillytavern.app/usage/st-reverse-proxy-guide

Configuration settings for config.yaml to enable remote access and basic authentication.

```yaml
listen: yes
whitelistMode: false
basicAuthMode: true
```

--------------------------------

### /qr-get

Source: https://docs.sillytavern.app/usage/st-script

Retrieves all properties of a Quick Reply.

```APIDOC
## /qr-get

### Description
Retrieves all of a Quick Reply's properties.

### Method
Slash Command

### Endpoint
/qr-get (set=string id=integer)

### Parameters
#### Arguments
- **set** (string) - Required - Name of the QR set
- **id** (integer) - Required - Identifier of the Quick Reply

### Request Example
/qr-get set=myQrSet id=42

```

--------------------------------

### /qr-contextadd

Source: https://docs.sillytavern.app/usage/st-script

Adds a context menu preset to a Quick Reply.

```APIDOC
## /qr-contextadd

### Description
Adds a context menu preset to a Quick Reply.

### Method
Slash Command

### Endpoint
/qr-contextadd (set=string label=string chain=bool [preset name])

### Parameters
#### Arguments
- **set** (string) - Required - Name of the QR set
- **label** (string) - Required - Text on the button
- **chain** (bool) - Required - Whether to chain the preset
- **preset name** (string) - Optional - Name of the preset to add

### Request Example
/qr-contextadd set=MyPreset label=MyButton chain=true MyOtherPreset

```

--------------------------------

### Run SillyTavern in Global Mode via CLI

Source: https://docs.sillytavern.app/installation

Use the --global argument with the server startup command to enable global mode.

```bash
node server.js --global
```

--------------------------------

### STScript /break in Closure

Source: https://docs.sillytavern.app/usage/st-script

Example of using /break to exit a closure early with a return value.

```stscript

/let x {: iterations=2
	/if left={{var::iterations}} rule=gt right=10 {: 
		/break too many iterations! |
	:} |
	/times {{var::iterations}} {: 
		/delay 500 |
		/echo {{timesIndex}} |
	:} |
:} |
/:x iterations=30 |
/echo the final result is: {{pipe}}

```

--------------------------------

### Translating Multiple Custom Attributes

Source: https://docs.sillytavern.app/for-contributors/i18n

Example of translating multiple custom attributes on a textarea element.

```html
<!--suppress HtmlUnknownAttribute -->
<textarea id="send_textarea" name="text" class="mdHotkeys"
          data-i18n="[no_connection_text]Not connected to API!;[connected_text]Type a message, or /? for help"
          placeholder="Not connected to API!"
          no_connection_text="Not connected to API!"
          connected_text="Type a message, or /? for help"></textarea>
```

```json
{
    "Not connected to API!": "Нет соединения с API!",
    "Type a message, or /? for help": "Введите сообщение или /? для помощи"
}
```

--------------------------------

### Initialize acme.json

Source: https://docs.sillytavern.app/usage/st-reverse-proxy-guide

Creates the acme.json file and sets its permissions to 600 for security.

```bash
touch acme.json
chmod 600 acme.json
```

--------------------------------

### Translating Simple Element Text

Source: https://docs.sillytavern.app/for-contributors/i18n

Example of translating a span element's text content.

```html
<span data-i18n="Role:">Role:</span>
```

```json
{
    "Role:": "Роль:"
}
```

--------------------------------

### Add QR Context Menu

Source: https://docs.sillytavern.app/usage/st-script

Adds a context menu preset to a specific Quick Reply.

```text
/qr-contextadd set=MyPreset label=MyButton chain=true MyOtherPreset
```

--------------------------------

### Navigate to Extras directory

Source: https://docs.sillytavern.app/extensions/extras/installation

Change the current directory to the cloned SillyTavern-extras folder.

```bash
cd SillyTavern-extras
```

--------------------------------

### STScript /break in /times Loop

Source: https://docs.sillytavern.app/usage/st-script

Example of using /break to exit a /times loop when a condition is met.

```stscript

/times 10 {: 
	/echo {{timesIndex}}
	/delay 500 |
	/if left={{timesIndex}} rule=gt right=3 {: 
		/break
	:} |
:} |

```

--------------------------------

### Return to docker directory

Source: https://docs.sillytavern.app/usage/st-reverse-proxy-guide

Navigates back to the root docker directory.

```bash
cd /docker
```

--------------------------------

### Text-to-image workflow with %model% placeholder

Source: https://docs.sillytavern.app/extensions/stable-diffusion

Shows the default text-to-image workflow JSON with the %model% placeholder for the checkpoint name, and the original JSON with a concrete filename. Use the placeholder version in your workflow to use the model selected in SillyTavern.

```json
{
    "class_type": "CheckpointLoaderSimple",
    "inputs": {
        "ckpt_name": "%model%"
    }
}
```

```json
{
    "class_type": "CheckpointLoaderSimple",
    "inputs": {
        "ckpt_name": "sd15.safetensors"
    }
}
```

--------------------------------

### Create Conda environment

Source: https://docs.sillytavern.app/extensions/extras/installation

Create a new Conda environment named extras.

```bash
conda create -n extras
```

--------------------------------

### Remote network connection console log

Source: https://docs.sillytavern.app/usage/remoteconnections

Example of a console message when a browser connects from a different machine on the same network.

```text

New connection from 192.168.116.187; User Agent: ...

```

--------------------------------

### Auto-Parse reasoning format

Source: https://docs.sillytavern.app/usage/prompts/reasoning

Example of a response format using <think> tags that can be automatically parsed when Auto-Parse is enabled.

```text
<think>
This is the reasoning.
</think>

This is the main content.
```

--------------------------------

### Create New QR Preset

Source: https://docs.sillytavern.app/usage/st-script

Creates a new QR preset, overriding any existing ones with the same name.

```text
/qr-presetadd slots=3 MyNewPreset
```

--------------------------------

### Using Unique Identifiers for Translation Keys

Source: https://docs.sillytavern.app/for-contributors/i18n

Example of using a custom attribute key instead of the English text.

```html
<!--suppress HtmlUnknownAttribute -->
<div class="openai_logit_bias_list" no_items_text="No items"
     data-i18n="[no_items_text]openai_logit_bias_no_items"></div>
```

```json
{
    "openai_logit_bias_no_items": "没有相关产品"
}
```

--------------------------------

### Enable remote connections in config.yaml

Source: https://docs.sillytavern.app/usage/remoteconnections

Set the listen option to true in the root config.yaml file to allow the server to accept connections from other devices.

```yaml
# Listen for incoming connections
listen: true
```

--------------------------------

### Pipe generated text to /sendas

Source: https://docs.sillytavern.app/usage/st-script

Example of generating text with /genraw and sending it as a character response using the /sendas command.

```stscript
/genraw You have been memory wiped, your name is now Lisa and you're tearing me apart. You're tearing me apart Lisa! |
/sendas name={{char}} {{pipe}}
```

--------------------------------

### STScript /run with /break

Source: https://docs.sillytavern.app/usage/st-script

Demonstrates /break inside a /run command.

```stscript

/run {: 
	/break 1 |
	/pass 2 |
:} |
/echo pipe will be one: {{pipe}} |

```

--------------------------------

### Perform a scene break or time jump

Source: https://docs.sillytavern.app/usage/api-connections/novelai

Use this format as a system message or at the start of a message to signal a scene change to the AI.

```text

***
[ 2 days later ]

```

--------------------------------

### Pipe generated text to /popup

Source: https://docs.sillytavern.app/usage/st-script

Example of generating text with /genraw and displaying the result in a popup window using the pipe operator.

```stscript
/genraw Write a funny message from Cthulhu about taking over the world. Use emojis. |
/popup <h3>Cthulhu says:</h3><div>{{pipe}}</div>
```

--------------------------------

### Run SillyTavern-extras with RVC and Edge TTS

Source: https://docs.sillytavern.app/extensions/rvc

Launches SillyTavern-extras with the RVC and edge-tts modules enabled. Optionally add '--cuda' to use GPU acceleration; VRAM usage was 3.4GB for 50 tokens and 7.6GB for 200 tokens in a quick test.

```shell
python server.py --enable-modules=rvc,edge-tts
```

--------------------------------

### Popup command with arguments

Source: https://docs.sillytavern.app/usage/st-script

Shows how to configure a large, wide popup with a custom button label using named arguments.

```stscript
/popup large=on wide=on okButton="Accept" Please accept our terms and conditions....
```

--------------------------------

### Docker Compose Configuration

Source: https://docs.sillytavern.app/usage/st-reverse-proxy-guide

Define the Traefik and SillyTavern services in docker-compose.yaml. Replace silly.DOMAIN.com with your actual subdomain.

```yaml
secrets:
    CF_DNS_API_KEY:
        file: ./secrets/cloudflare/CF_DNS_API_KEY

services:
    traefik:
        image: traefik:latest
        container_name: traefik
        restart: unless-stopped
        secrets:
            - CF_DNS_API_KEY
        ports:
            - "80:80"
            - 443:443
            - 8080:8080
        environment:
            CLOUDFLARE_DNS_API_TOKEN_FILE: /run/secrets/CF_DNS_API_KEY
            CLOUDFLARE_ZONE_API_TOKEN_FILE: /run/secrets/CF_DNS_API_KEY
        volumes:
            - /var/run/docker.sock:/var/run/docker.sock:ro
            - ./appdata/traefik/traefik.yml:/traefik.yml:ro
            - ./appdata/traefik/config.yml:/config.yml:ro
            - ./appdata/traefik/acme.json:/acme.json
            - /etc/localtime:/etc/localtime:ro
    sillytavern:
        build: ./SillyTavern
        container_name: sillytavern
        hostname: sillytavern
        image: ghcr.io/sillytavern/sillytavern:latest
        volumes:
            - "./appdata/sillytavern/config:/home/node/app/config"
            - "./appdata/sillytavern/data:/home/node/app/data"
        restart: unless-stopped
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.sillytavern.entrypoints=http"
            - "traefik.http.routers.sillytavern.rule=Host(`silly.DOMAIN.com`)"
            - "traefik.http.middlewares.sillytavern-https-redirect.redirectscheme.scheme=https"
            - "traefik.http.routers.sillytavern.middlewares=sillytavern-https-redirect"
            - "traefik.http.routers.sillytavern-secure.entrypoints=https"
            - "traefik.http.routers.sillytavern-secure.rule=Host(`silly.DOMAIN.com`)"
            - "traefik.http.routers.sillytavern-secure.tls=true"
            - "traefik.http.routers.sillytavern-secure.service=sillytavern"
            - "traefik.http.services.sillytavern.loadbalancer.server.port=8000"

networks:
    internal:
        driver: bridge
```

--------------------------------

### Run SillyTavern in Global Mode via Startup Script

Source: https://docs.sillytavern.app/installation

Pass the --global argument to the shell startup script for Windows or Linux/Mac environments.

```bash
Start.bat --global
```

```bash
./start.sh --global
```

--------------------------------

### Executing Closures with /run

Source: https://docs.sillytavern.app/usage/st-script

Using the /run command to execute a closure immediately.

```stscript
/run {:
	/add 1 2 3 4 |
:} |
/echo |
```

--------------------------------

### Calling a procedure with /run

Source: https://docs.sillytavern.app/usage/st-script

Basic syntax for calling a script defined in Quick Replies by its label.

```stscript

/run ScriptLabel

```
Tokens:
Raw