|
| 1 | +# Running SkynetClaw on Linux |
| 2 | + |
| 3 | +SkynetClaw is developed on Windows but the backend is platform-neutral, and CI |
| 4 | +proves that on Ubuntu on every push. This page covers what a Linux install |
| 5 | +actually needs. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## Quick path |
| 10 | + |
| 11 | +```bash |
| 12 | +git clone https://github.com/ElmatadorZ/skynetclaw.git |
| 13 | +cd skynetclaw |
| 14 | +./start.sh |
| 15 | +``` |
| 16 | + |
| 17 | +`start.sh` creates the virtualenv, installs the five dependencies, seeds both |
| 18 | +config templates, runs the database migration, warns if Ollama is unreachable, |
| 19 | +and starts the server. It is idempotent — run it again any time. |
| 20 | + |
| 21 | +Or with `make`: |
| 22 | + |
| 23 | +```bash |
| 24 | +make setup && make run |
| 25 | +``` |
| 26 | + |
| 27 | +Or skip Python entirely: |
| 28 | + |
| 29 | +```bash |
| 30 | +docker compose up -d |
| 31 | +docker compose exec ollama ollama pull llama3.1:8b |
| 32 | +``` |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +## System packages |
| 37 | + |
| 38 | +Only Python is strictly required. Everything else is optional and degrades |
| 39 | +gracefully — a missing component disables one capability, it does not stop the |
| 40 | +system. |
| 41 | + |
| 42 | +### Debian / Ubuntu |
| 43 | + |
| 44 | +```bash |
| 45 | +sudo apt update |
| 46 | +sudo apt install -y python3 python3-venv python3-pip curl |
| 47 | + |
| 48 | +# optional — OCR for scanned PDFs and images |
| 49 | +sudo apt install -y tesseract-ocr tesseract-ocr-tha |
| 50 | +``` |
| 51 | + |
| 52 | +### Fedora / RHEL |
| 53 | + |
| 54 | +```bash |
| 55 | +sudo dnf install -y python3 python3-pip curl |
| 56 | +sudo dnf install -y tesseract tesseract-langpack-tha # optional |
| 57 | +``` |
| 58 | + |
| 59 | +### Arch |
| 60 | + |
| 61 | +```bash |
| 62 | +sudo pacman -S python python-pip curl |
| 63 | +sudo pacman -S tesseract tesseract-data-tha # optional |
| 64 | +``` |
| 65 | + |
| 66 | +OCR is discovered from `PATH` first, so a package-manager install needs no |
| 67 | +configuration. Without it, `doc_reader` simply reports that OCR is unavailable. |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +## A local model |
| 72 | + |
| 73 | +```bash |
| 74 | +curl -fsSL https://ollama.com/install.sh | sh |
| 75 | +ollama serve & # or: systemctl --user start ollama |
| 76 | +ollama pull llama3.1:8b |
| 77 | +ollama pull qwen2.5-coder:7b # the execution path |
| 78 | +``` |
| 79 | + |
| 80 | +**No GPU required.** A 7–8B model runs on CPU; it is slower, not broken. With an |
| 81 | +NVIDIA GPU and the container toolkit installed, Ollama uses it automatically. |
| 82 | + |
| 83 | +Full provider matrix, including cloud APIs: **[MODELS.md](MODELS.md)**. |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +## What Linux discovers automatically |
| 88 | + |
| 89 | +These were Windows-shaped and are now probed per platform: |
| 90 | + |
| 91 | +| Capability | Linux locations searched | |
| 92 | +|---|---| |
| 93 | +| **Obsidian vault** | `~/Documents/Obsidian Vault`, `~/Obsidian`, `~/Notes`, `~/vault`, `~/Nextcloud/Obsidian`, `~/Dropbox/Obsidian`, `~/Sync/Obsidian`, `/vault`, `/data/obsidian` | |
| 94 | +| **Obsidian vault registry** | `$XDG_CONFIG_HOME/obsidian/obsidian.json`, `~/.config/obsidian/obsidian.json`, and the Flatpak path under `~/.var/app/md.obsidian.Obsidian/` | |
| 95 | +| **Tesseract binary** | `PATH`, then `/usr/bin`, `/usr/local/bin`, `/opt/homebrew/bin`, `/snap/bin` | |
| 96 | +| **tessdata** | `$TESSDATA_PREFIX`, `/usr/share/tesseract-ocr/5/tessdata`, `/usr/share/tessdata`, `/usr/local/share/tessdata` | |
| 97 | +| **Agent workspace** | `~/Desktop/workspace` when a Desktop exists, otherwise `~/skynetclaw-workspace` — headless servers and non-English XDG names are handled | |
| 98 | + |
| 99 | +Set an explicit vault path in `backend/settings.json` to skip discovery entirely. |
| 100 | + |
| 101 | +--- |
| 102 | + |
| 103 | +## Shell execution on Linux |
| 104 | + |
| 105 | +The agent's `shell_command` tool runs through the platform's own shell. The |
| 106 | +system already branches on `os.name`, so PowerShell-specific handling applies |
| 107 | +only on Windows; on Linux commands go to `/bin/sh` unchanged. |
| 108 | + |
| 109 | +This is the highest-risk capability in the system. The GPS-2 gate is |
| 110 | +deny-by-default and irreversible actions require a human gate — leave those on. |
| 111 | +See [NOTICE](../NOTICE). |
| 112 | + |
| 113 | +--- |
| 114 | + |
| 115 | +## Running as a service |
| 116 | + |
| 117 | +`systemd --user` unit, adjusting `WorkingDirectory`: |
| 118 | + |
| 119 | +```ini |
| 120 | +# ~/.config/systemd/user/skynetclaw.service |
| 121 | +[Unit] |
| 122 | +Description=SkynetClaw |
| 123 | +After=network.target |
| 124 | + |
| 125 | +[Service] |
| 126 | +Type=simple |
| 127 | +WorkingDirectory=%h/skynetclaw |
| 128 | +ExecStart=%h/skynetclaw/start.sh |
| 129 | +Restart=on-failure |
| 130 | +RestartSec=10 |
| 131 | + |
| 132 | +[Install] |
| 133 | +WantedBy=default.target |
| 134 | +``` |
| 135 | + |
| 136 | +```bash |
| 137 | +systemctl --user daemon-reload |
| 138 | +systemctl --user enable --now skynetclaw |
| 139 | +systemctl --user status skynetclaw |
| 140 | +journalctl --user -u skynetclaw -f |
| 141 | +``` |
| 142 | + |
| 143 | +For a system-wide unit, run it as a dedicated unprivileged user whose home is the |
| 144 | +only workspace the agent can reach. |
| 145 | + |
| 146 | +--- |
| 147 | + |
| 148 | +## Ports |
| 149 | + |
| 150 | +| Port | Service | Bound to | |
| 151 | +|---|---|---| |
| 152 | +| 8766 | SkynetClaw backend | `127.0.0.1` by default | |
| 153 | +| 11434 | Ollama | localhost | |
| 154 | +| 8080 | execution runtime (optional) | localhost | |
| 155 | + |
| 156 | +The backend binds to loopback deliberately. **Do not expose 8766 to a network** |
| 157 | +without putting authentication in front of it — the API can run tools and write |
| 158 | +files, and it has no built-in authentication. |
| 159 | + |
| 160 | +--- |
| 161 | + |
| 162 | +## Known Linux gaps |
| 163 | + |
| 164 | +Stated rather than discovered later: |
| 165 | + |
| 166 | +- **`.bat` / `.ps1` launchers do not apply.** Use `start.sh`, `make`, or Docker. |
| 167 | +- **macOS is not in CI.** It should work — the Linux code path is POSIX — but it |
| 168 | + is untested, so it is marked as such in the README rather than claimed. |
| 169 | +- **Tesseract language data** for non-English OCR must be installed separately |
| 170 | + (`tesseract-ocr-tha` and friends). |
| 171 | +- **File-path handling in agent prompts** is written with Windows examples in |
| 172 | + places. It functions on Linux, but a model may occasionally produce |
| 173 | + Windows-style guidance in its explanations. |
| 174 | + |
| 175 | +If you hit something else, please open an issue with the distribution, the |
| 176 | +Python version, and the failing output. |
0 commit comments