How to Install SillyTavern
SillyTavern can be installed on Windows, Linux, MacOS and Android
Installation Instructions
SillyTavern does not currently support install on iOS but can be accessed via those devices
once installed on a compatible operating system
Automatic Installation - SillyTavern Launcher
A simple command line based GUI that will automatically install SillyTavern and SillyTavernExtras and all of their dependencies for you.
You will also need to connect a AI model to SillyTavern, we have a guide on how to use "OpenRouter" a service that provides many free and cheap LLM models for powering SillyTavern.
1. On your keyboard: press WINDOWS + R to open Run dialog box. Then, run the following command to install git:
cmd /c winget install -e --id Git.Git
2. On your keyboard: press WINDOWS + E to open File Explorer, then navigate to the folder where you want to install the launcher.
3. Once in the desired folder, type `cmd` into the address bar and press enter. Then, run the following command:
git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher && start installer.bat
1. Open your favorite terminal and install git
2. Download Sillytavern Launcher with:
git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher
3. Start the installer with:
chmod +x install.sh && ./install.sh
then choose what you wanna install
4. After installation start the launcher with:
chmod +x launcher.sh && ./launcher.sh
1. Open a terminal and install brew with:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)
2. Then install git with:
brew install git
3. Download Sillytavern Launcher with:
git clone https://github.com/SillyTavern/SillyTavern-Launcher.git
4. Navigate to the SillyTavern-Launcher with:
cd SillyTavern-Launcher
5. Start the install launcher with:
chmod +x install.sh && ./install.sh
then choose what you wanna install
6. After installation start the launcher with:
chmod +x launcher.sh && ./launcher.sh
The tutorial below is a step by step guide to signing up for OpenRouter and getting an API key with the steps for use inside of SillyTavern to use models powered by OpenRouter for chat completion.
Manual Video Installation Instructions
MacOS
Manual Installation Instructions
To install SillyTavern on Windows follow the steps below:
Official Install Documentation: https://docs.sillytavern.app/installation/windows/
Recommended install: Use the SillyTavern Launcher
- Visit the Github here: https://github.com/SillyTavern/SillyTavern-Launcher for install instructions
Simple video guide on manual installation here: https://www.youtube.com/watch?v=PMX165GyLAg (Duration: 4:13)
- Install NodeJS (latest LTS version is recommended)
- Download the zip from the GitHub repo: https://github.com/SillyTavern/SillyTavern/releases (Scroll down past the change log to the Assets section and download the zip file, we recommend using the latest release over the preview branch unless you are willing to experience bugs)
- Unzip it into a folder of your choice
- Run start.bat via double-clicking or in a command line.
- Once the server has prepared everything for you, it will open a tab in your browser
Warnings
- DO NOT INSTALL INTO ANY WINDOWS CONTROLLED FOLDER (Program Files, System32, etc).
- DO NOT RUN START.BAT WITH ADMIN PERMISSIONS
To install SillyTavern on Linux follow the steps below:
Official Install Documentation: https://docs.sillytavern.app/installation/linuxmacos/
Simple video guide here: https://www.youtube.com/watch?v=TLuEdy5YIhY (Duration: 2:14)
- Download the zip from the GitHub repo: https://github.com/Cohee1207/SillyTavern/releases (Scroll down past the change log to the Assets section and download the zip file, we recommend using the lastest release over the preview branch unless you are willing to experience bugs)
- Unzip it into a folder of your choice
- Run the
start.sh
script. - Enjoy!
To install SillyTavern on MacOS follow the steps below:
Official Install Documentation: https://docs.sillytavern.app/installation/linuxmacos/
Requirements
- Install NodeJS (latest LTS version is recommended, you can download the package and install or follow the terminal commands below)
- Install GIT
Install Via Terminal:
- Install
nvm
(NodeJS Version Manager) by running the following command in Terminal:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
- Run this to make
nvm
usable:
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
- Install NodeJS by running the following command:
nvm install node
- Install SillyTavern via NPX by running the following command, you can re-open SillyTavern by running the command again. Omit the
@latest
part of the command to not auto-pull the latest update as that might overwrite all your previous characters and chatlogs.
npx sillytavern@latest
Install Manually:
- Clone the repo using GIT:
git clone -b dev https://github.com/SillyTavern/SillyTavern && cd SillyTavern
- Run SillyTavern
npm i && node server.js
To install SillyTavern on Android follow the steps below:
- Installing and running SillyTavern on Android is a bit more complicated than on desktop
- Follow each step on the following guide here: https://rentry.org/STAI-Termux
- This guide comes from a 3rd party and has not been vetted by sillytavernai.com, use at your own judgement
- The SillyTavern Devs will not provide any support for running this on Android. Direct all your questions to the creator of this guide.
As of version 1.5.1 the developers no longer support colab hosting. You can still host your own!
To Install SillyTavernExtras Extensions follow the steps below:
Official Documentation: https://docs.sillytavern.app/extras/installation/
Option 1 - Conda Installation (recommended)
- Install Miniconda: https://docs.conda.io/en/latest/miniconda.html
- (Important!) Read how to use Conda: https://conda.io/projects/conda/en/latest/user-guide/getting-started.html
- Install git: https://git-scm.com/downloads
Execute the following commands ONE BY ONE in the CONDA COMMAND PROMPT (Not windows Command Prompt)
- Before the first run, create an environment (let's call it
extras
):
conda create -n extras
- Now activate the newly created env
conda activate extras
- Install the required system packages
conda install pytorch=2.0.0 torchvision=0.15.0 torchaudio=2.0.0 pytorch-cuda=11.7 git -c pytorch -c nvidia
- Clone this repository
git clone https://github.com/Cohee1207/SillyTavern-extras
- Navigated to the freshly cloned repository
cd SillyTavern-extras
- Install the project requirements
pip install -r requirements.txt
- Run the Extensions API server
python server.py --enable-modules=caption,summarize,classify
- Copy the Extra's server API URL listed in the console window after it finishes loading up. On local installs, this defaults to
http://localhost:5100
. - Open your SillyTavern config.conf file (located in the base install folder), and look for a line "
const enableExtensions
". Make sure that line has "= true
", and not "= false
". - Start your SillyTavern server
- Open the Extensions panel (via the 'Stacked Blocks' icon at the top of the page), paste the API URL into the input box, and click "Connect" to connect to the Extras extension server.
- To run again, simply activate the environment and run these commands. Be sure to the additional options for server.py (see below) that your setup requires.
conda activate extras
python server.py
Option 2 - Vanilla
- Install Python 3.10: https://www.python.org/downloads/release/python-31010/
- Install git: https://git-scm.com/downloads
- Clone the repo:
git clone https://github.com/Cohee1207/SillyTavern-extras
cd SillyTavern-extras
Run the following command:
python -m pip install -r requirements.txt
Run the following command:
python server.py --enable-modules=caption,summarize,classify
Get the API URL. Defaults to http://localhost:5100 if you run locally.
Start SillyTavern with extensions support: set enableExtensions to true in config.conf
Navigate to SillyTavern extensions menu and put in an API URL and tap "Connect" to load the extensions
What about mobile/Android/Termux?
There are some folks in the community having success running Extras on their phones via Ubuntu on Termux. This project wasn't made with mobile support in mind, so this guide is provided strictly for your information only: https://rentry.org/STAI-Termux#downloading-and-running-tai-extras IMPORTANT
- The SillyTavern Devs will not provide any support for running this on Android. Direct all your questions to the creator of this guide.
Need Help?
Visit the FAQ, Subreddit, Discord or GitHub to ask questions of community members and the development team.
Frequently Asked Questions: Sillytavernai.com/faq
Reddit: https://www.reddit.com/r/SillyTavernAI
Discord: https://discord.gg/RZdyAEUPvj