Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/flick9000/winscript/llms.txt

Use this file to discover all available pages before exploring further.

Winscript is built on top of Tauri v2 (the Rust-powered desktop runtime), Astro (the frontend framework that drives the UI), Node.js (for package management and the Astro dev server), and Rust/Cargo (the native backend compiler). You’ll need all four toolchains present on your machine before you can run or build the project locally.
1

Install Node.js LTS

Winscript’s frontend tooling requires a current LTS release of Node.js. Install it via Winget:
winget install --id OpenJS.NodeJS.LTS
2

Install Rust & Cargo

Tauri compiles a native Rust backend for the desktop window and OS integrations. Install the Rust toolchain through Rustup:
winget install --id Rustlang.Rustup
After the installer finishes, open a new terminal so that rustc and cargo are available on your PATH.
3

Clone the repository

Clone the Winscript repository from GitHub, then navigate into the app directory where the Node.js project lives:
git clone https://github.com/flick9000/winscript.git
cd winscript/app
4

Install dependencies

Install all Node.js dependencies (Astro, Tauri CLI, plugins, and dev tools):
npm install
5

Run in development mode

Start the Tauri development window. This launches the Astro dev server and then opens the native desktop window pointed at it:
npm run tauri dev
Tauri’s dev mode supports hot-reload — any changes you make to Astro source files are reflected immediately in the running window without needing a full rebuild or restart.
6

Build a release binary

Compile an optimized, release-ready executable and installer:
npm run tauri build
Once the build completes, the standalone executable is available at:
src-tauri/target/release/winscript.exe
An NSIS installer bundle is also produced alongside it at:
src-tauri/target/release/bundle/nsis/
The Winscript window enforces a minimum size of 750 × 700 pixels, as defined in tauri.conf.json. Resizing below this threshold is not permitted. Make sure your display resolution meets this requirement when running or testing the app.

Build docs developers (and LLMs) love

Get started for freeTalk to us