Setup guide

Set up Shika AI.

Pick your system. The page shows the steps for the one you choose, and it starts on the one it thinks you use.

Before you start

Honest status: Linux is the system this was built and used on every day. The Mac and Windows versions pass automated tests that simulate the keyboard, microphone and windows, but they have not been run on real Macs or PCs by the author yet. If something breaks, please open an issue on GitHub with your system version and the text from the terminal.

  • Kubuntu or any Ubuntu based system. KDE Plasma 6 is best, since it also gives you the native Plasma widgets.
  • About 1 GB of free disk space, or about 2 GB if you also install the language model. The speech model alone is about 500 MB.
  • A microphone.
  • Internet for the install and the first model download. After that it works offline.

Install

  1. Open a terminal and run these three lines.
git clone https://github.com/iam-knr/desktop-buddy.git
cd desktop-buddy
bash install.sh
  1. The script asks for your password once to install packages with apt, add a rule so push-to-talk can read your keyboard, and add you to the input group.
  2. Log out and log back in one time. This is needed for the input group.
  3. The buddy starts at login from now on. To start it right away, open it from the application menu.

On KDE Plasma the installer also adds the Tasks, Sticky Note, Focus and Clock widgets through kpackagetool6. Right click the desktop, choose Add Widgets, and search for them.

First run

  1. A small pet companion walks onto your desktop. That is the buddy. Its name is printed on a red belt.
  2. The first start downloads the speech model. It takes a few minutes and the buddy says when it is ready.
  3. Click the buddy to pet it. Right click for the menu, where you can pick a character, rename it and open the reminders.
  4. Say "call yourself Momo" with the command key held, or rename it from the menu.

Keys and voice

You doWhat happens
Hold Right Ctrl, speak, let goYour words are typed where your cursor is.
Hold Right Alt (Right Option on a Mac), speak, let goIt runs the command you said.
Say "open firefox", "close tab", "lock screen", "volume up"Opens the app or presses the shortcut for you.
Say "search" and then your wordsOpens a web search.
Say "remind me at 5 to call Rahul"Adds a reminder. The buddy runs to the middle of the screen and barks when it is due.
Tap the buddy while it barksMarks the reminder done. Double-tap to snooze 10 minutes.

If a keyboard does not have a Right Ctrl key, change DICTATE_KEY and COMMAND_KEY in the program file.

Shika AI and models

Two settings control the AI. They are plain lines in the program file, shika.py. Search the file for the name to find the line.

SettingWhat it controlsDefault
WHISPER_MODELSpeech to text (faster-whisper)small.en
WHISPER_LANGSpeech language. None means auto detect.en
OLLAMA_MODELText cleanup and voice edits (Ollama)qwen2.5:1.5b
OLLAMA_URLWhere Ollama is runninghttp://127.0.0.1:11434

Turn Shika AI on

The installer asks if you want the language model, and the default answer is yes. If you skipped it, run the installer again with the AI option. Or install Ollama yourself and run ollama pull qwen2.5:1.5b.

bash install.sh --with-ollama

To check it, open the dashboard health check. The row "Shika AI (local model)" shows the model name when it is answering.

Change the language model

  1. Pick a model from the Ollama library, or from the table below.
  2. Download it: ollama pull qwen2.5:3b (use your model name).
  3. Open the installed program file, find OLLAMA_MODEL and put your model name inside the quotes.
  4. Restart Shika with the command in the Restart section.
nano ~/.local/share/shika/shika.py
# in nano, press Ctrl+W and search for OLLAMA_MODEL
ModelSizeWhat to expect
qwen2.5:1.5babout 1 GBThe default. Fast on a CPU. Good for cleanup.
llama3.2:1babout 1.3 GBSmall and quick. Slightly simpler wording.
qwen2.5:3babout 1.9 GBBetter wording and edits. Slower.
llama3.2:3babout 2 GBAnother 3B option. Slower.
qwen2.5:7babout 4.7 GBBest quality of these. Needs 8 GB or more of memory and is slow on a CPU.

Sizes are approximate. Ollama shows the exact size when you pull a model. A bigger model is smarter but slower. If the model takes too long, Shika gives up after a few seconds and uses its basic cleanup, so choose the biggest model that still answers quickly on your computer.

Use Ollama on another computer

Set OLLAMA_URL to the address of another machine that runs Ollama, for example http://192.168.1.20:11434. Your text then goes to that machine on your own network. Shika talks to the Ollama API only. Other services, such as hosted chat APIs, need code changes.

Change the speech model

Find WHISPER_MODEL and change the name. The new model downloads the next time Shika starts.

ModelSizeWhat to expect
base.enabout 140 MBFastest. Misses more words and accents.
small.enabout 500 MBThe default. A good balance for English.
medium.enabout 1.5 GBMore accurate. Noticeably slower on a CPU.
small or mediumabout 500 MB or 1.5 GBMultilingual. Use these for languages other than English.
large-v3about 3 GBMost accurate and multilingual. Slow without a graphics card.

For another language, pick a multilingual model and set WHISPER_LANG = None to auto detect, or a language code such as "hi" for Hindi. Models without ".en" in the name are multilingual. Non-English use has had much less testing.

Keep your change when you update

The installer copies shika.py over the installed one, so an update replaces your edit. To keep it, make the same change in the cloned folder (shika/shika.py) before you run the installer. To go back, set the values to the defaults above and restart.

Widgets

Four small windows float on your desktop on every system. They remember where you put them.

Open them from the reminder panel buttons, or say "show tasks widget", "focus timer", "clock widget", "new sticky note" or "hide all widgets". From a terminal you can run the program with --widgets.

Restart and update

Stop it and start it again:

pkill -f "shika/shika.py"; nohup env QT_QPA_PLATFORM=xcb ~/.local/share/shika/venv/bin/python3 ~/.local/share/shika/shika.py --autostart >/dev/null 2>&1 &

To update, run git pull in the folder and run bash install.sh again.

Fixes

The key does nothing when I hold it

You probably have not logged out and in since the install. Run groups in a terminal. If "input" is missing, log out and in again.

It hears nothing

Check the microphone in your system sound settings and say a few words to see the level move. On a Mac and on Windows, also check the microphone privacy setting for the app.

The words are wrong

The default model is small.en. A larger model is more accurate and slower. A smaller one is faster and misses more. Speak at a normal pace and keep the mic near you.

The first start is slow

It is downloading the model, about 500 MB. After that it starts in a few seconds.

I cannot see the buddy

It may be behind a full screen app, or on another screen. Say "come here" or restart it with the command above.

The fix text command does nothing

That part needs the language model. Install Ollama and a model, or run the installer again with the AI option. See Shika AI and models. The rest works without it.

Your data

Everything stays on your computer in plain files. Reminders, notes, timer state and settings are JSON files you can open and back up.

SystemWhere
Linux~/.config/shika and ~/.local/share/summit
macOS~/Library/Application Support/Shika and /Summit
Windows%APPDATA%\Shika and %LOCALAPPDATA%\Summit

Uninstall

bash uninstall.sh

Your reminders and notes are left in place unless you delete the data folders above.

Built with Monster Energy Zero Ultra can &