Gauge

START HERE

Getting started

Run Gauge on your computer, finish setup and add your first engagement.

Gauge runs on your own computer with rer, the Run Edit Run command. You need Node 22 or later and pnpm 10.12.4, on macOS, Linux or Windows with WSL2.

Install rer

Once per computer:

Shell
curl -fsSL https://runeditrun.com/install.sh | sh
export PATH="$HOME/.local/bin:$PATH"

Or, with npm: npm install -g @runeditrun/rer.

Get Gauge and start it

Shell
git clone https://github.com/just-every/run-gauge.git
cd run-gauge && rer dev

rer dev installs everything, makes you the owner and starts Gauge. A first start can take a few minutes. When it is ready it prints a RER_OPEN link: open it on this computer and Gauge opens signed in as you. Keep that link private, because it signs you in.

To stop Gauge, run rer dev --stop. Run rer dev again whenever you want to use it; your records stay where they were.

Finish setup

The first time you open Gauge it shows Finish setup. Check your name and email, tick I confirm this owner account is ready to use. and choose Finish setup. Gauge opens on Review, which is empty until you add work.

After setup, the address Gauge prints shows a small page with Sign in. Gauge itself lives at /app.

Add your first engagement

Gauge starts with no records; nothing is made up for you. As the owner you hold finance authority, so you can set everything up yourself.

  1. On Engagements, add a Client and each Person who records time, with their work timezone. Tick Contractor for contractors.
  2. Add an Engagement: its name, client, responsible lead, assigned people, agreed scope and work timezone.
  3. Open the engagement and add New terms / change order: hourly or fixed fee, the budget, the estimated effort and the reason. Choose Approve terms. Time can only be approved against approved terms.
  4. Add the engagement's tasks under Task and remaining effort, and any fixed-fee milestones.
  5. On Rates, add cost and bill rates for each person, or for a service.

Enter amounts in Australian dollars and durations in hours, the way Gauge shows them everywhere else.

Bring in your team

On Access, invite each person by email. Once they accept, connect their sign-in to their person record and give them a role. Read People and access for what each role can do.

Next