Skip to content

dev.local.md

Latest commit

 

History

History
189 lines (124 loc) · 3.09 KB

dev.local.md

File metadata and controls

189 lines (124 loc) · 3.09 KB

Jot Local Dev Setup

This file is for bringing Jot up quickly on a fresh local machine.

1. Open the Repo

PowerShell:

cd C:\Users\mamba\jot

Git Bash:

cd ~/jot

2. Set Local Build Cache First

This matters on Windows because the default Go cache path has caused Access is denied during builds and tests.

PowerShell:

$env:GOCACHE="C:\Users\mamba\AppData\Local\Temp\jot-gocache"

Git Bash:

export GOCACHE=/c/Users/mamba/AppData/Local/Temp/jot-gocache

3. Set Assistant Environment Variables

Only set what you actually use.

Ollama

If using local Ollama only:

$env:JOT_ASSISTANT_PROVIDER="ollama"
$env:JOT_ASSISTANT_MODEL="glm-5:cloud"

If using Ollama Cloud:

$env:OLLAMA_API_KEY="your-ollama-api-key"

Gmail OAuth

If you want Gmail onboarding and auth available immediately:

$env:JOT_GMAIL_CLIENT_ID="your-google-desktop-client-id"
$env:JOT_GMAIL_CLIENT_SECRET="your-google-desktop-client-secret"

You can also keep these in your Jot assistant config instead of exporting them every session.

4. Optional: WhatsApp Bridge Dependencies

Only needed if you are working on WhatsApp native bridge flows.

cd tools\whatsapp-bridge
npm install
cd ..\..

5. Build the Project

Terminal build:

go build

Explicit test binary build:

go build -o jot-test.exe .

Windows GUI build:

go build -ldflags="-H windowsgui" -o jot.exe .

6. Run Tests

Full suite:

go test ./...

Focused smoke examples:

go test -run TestGmailExecuteSendEmail_FallsBackToDraftWhenSendFails -v
go test -run TestEnsureGmailSendReady_ReauthsInlineAndContinues -v

7. Run the Main Flows

Interactive assistant:

.\jot.exe assistant

Guided onboarding:

.\jot.exe assistant --onboarding

Status:

.\jot.exe assistant status

Browser computer:

.\jot.exe assistant browser status
.\jot.exe assistant auth browser

Gmail auth:

.\jot.exe assistant auth gmail

Journal backup test:

.\jot.exe assistant "export my jot journal and email it to me"

8. Versioning

Current local beta line:

For local-only beta bumps, update the CLI version in main.go first. Do not touch Homebrew, npm, or Chocolatey packaging unless you are preparing a real release.

9. Before You Commit

Run in this order:

gofmt -w .
go test ./...
go build -o jot-test.exe .
git status --short

Then inspect for local-only artifacts. Do not commit:

  • client_secret_*.json
  • local screenshots or random assets
  • .state output from tools/whatsapp-bridge
  • temporary binaries unless you intentionally want them tracked

10. Push Workflow

Typical flow:

git add .
git commit -m "Your message"
git push origin main

If you are continuing assistant-heavy work, read these first:

  1. README.md
  2. ASSISTANT.md
  3. agents.md