Installation
Scopwis ships native packages for the major client platforms plus a Rust Server and a combined CLI/TUI. Package formats follow the platform rather than forcing every operating system into one archive type.
Choose a deployment
For local development, build from source:
git clone https://github.com/scopwis/scopwis.git
cd scopwis
cp .env.example .env
make setup
make dev
For browser-focused development:
make dev-web
The local Server listens on http://127.0.0.1:3000 by default.
For a native Server build:
cargo run --locked -p scopwis-server --release
For a released container, use the version published by the project:
docker run --rm \
-p 3000:3000 \
-v scopwis-data:/var/lib/scopwis/data \
ghcr.io/scopwis/scopwis-server:<version>
The container stores runtime state under /var/lib/scopwis/data.
Client packages
Release assets use platform-native packaging:
| Platform | Typical package |
|---|---|
| Android | APK / AAB |
| iOS | IPA |
| macOS | DMG / ZIP |
| Windows | MSIX / MSI / ZIP |
| Linux | tar.gz |
| Web | static tar.gz |
| CLI / TUI | platform archive or installer |
| Server | Linux archive and OCI image |
Beta/testing artifacts are intentionally distinguished from protected production-signed assets. Treat a testing artifact as compatibility evidence, not as a stable signing chain.
Minimal Server configuration
SCOPWIS_HOST=127.0.0.1
SCOPWIS_PORT=3000
SCOPWIS_DATA_ROOT=/path/to/data
SCOPWIS_LOAD_PUBLIC_DATA=true
Configure the reasoning model separately; see Model providers.
Verify the Server
curl http://127.0.0.1:3000/health
For a source checkout, the repository also exposes:
make doctor
make backend-smoke
Do not expose a non-loopback Server publicly until authentication, allowed origins, model credentials, and data-source policy are configured. Public endpoints should use HTTPS.