Start here1 min read

Getting started

Install both products, run this site locally, and know which commands matter.

Updated Nov 1, 20251 min readEdit this page

On this page

There are three ways to run Lumo: the Chrome Web Store, a GitHub Actions artifact, or a local build. The userscript manager is distributed through GitHub Releases. This site is a standard Vite project.

Install Lumo#

1
Chrome Web Store
The stable channel. It auto-updates, but each release waits for Google review, so it can lag behind main.
2
GitHub Actions artifact
Download the latest successful lumo-chrome-mv3 artifact, unzip it, open chrome://extensions, enable Developer mode and choose Load unpacked.
3
Build from source
Clone the repository, install dependencies, build, then load .output/chrome-mv3.

Build Lumo from sourcebash

git clone https://github.com/mscststs/lumo.gitcd lumonpm installnpm run build# chrome://extensions → Load unpacked → .output/chrome-mv3

Install Lumo Userscripts#

Userscripts require Chrome 138 or newer and the native chrome.userScripts API. Chrome asks you to allow user scripts for the extension once.

Download the latest archive from GitHub Releases, or build from source.
Open chrome://extensions, enable Developer mode and load the unpacked directory.
On the extension card, enable Allow User Scripts.

The switch is mandatory

Without Allow User Scripts, the manager can install and edit scripts but Chrome will not execute them.

Run this website locally#

Websitebash

npm installnpm run dev       # http://localhost:5173npm run typechecknpm run testnpm run build     # pre-renders every route into build/client

Command	What it does
`npm run dev`	React Router dev server with HMR.
`npm run build`	Pre-renders all routes and writes static HTML.
`npm run preview`	Serves `build/client` through Wrangler.
`npm run typecheck`	Generates route types, then runs `tsc --noEmit`.
`npm run test`	Vitest: i18n parity, docs integrity, theme contrast.
`npm run deploy`	Deploys `build/client` as Worker static assets.