Quick start

Requirements

• Node.js 18+
• Rust stable toolchain
• Platform-specific Tauri prerequisites (docs)

Install

git clone https://github.com/openqmt/PeekShell.git
cd PeekShell
npm install

Development

npm run tauri-dev

This starts the Vite frontend and the Tauri desktop window. For frontend-only work:

npm run dev

Build

npm run build
# Full desktop installers:
# npx tauri build

Documentation site

This site is powered by VitePress. Sources live under docs/ in the repo:

npm run docs:dev      # local preview
npm run docs:build    # static build
npm run docs:preview  # preview the build

Next

• Hosts — add and organize SSH hosts
• Terminal — multi-tab sessions and host overview
• Remote files — browse and transfer files
• AI assistant — configuration and confirmation flow