Skip to content

BUILDING.md

Latest commit

 

History

History
152 lines (116 loc) · 4.95 KB

BUILDING.md

File metadata and controls

152 lines (116 loc) · 4.95 KB
Raw

Building from Source

Prerequisites

  • Rust stable with the x86_64-pc-windows-msvc target
  • Microsoft Visual Studio Build Tools with the Desktop development with C++ workload
  • Node.js 22.13+ (24 recommended) and pnpm 11

Install the tools manually with rustup/winget/corepack, or use a tool manager such as mise. There is no automatic Windows bootstrap script in this port.

Build the Desktop App

cd apps/desktop-tauri
pnpm install --frozen-lockfile
cd ../..
pnpm --dir apps/desktop-tauri run tauri:build

The release binary lands at target/release/codexbar-desktop-tauri.exe.

For a debug build (faster compile, no optimisations):

cd apps/desktop-tauri
pnpm run tauri:build:debug

Build the CLI Only

cargo build -p codexbar --release
# Binary at: target/release/codexbar.exe

Dev Mode (Hot Reload)

.\scripts\dev.ps1           # default debug build + launch
.\scripts\dev.ps1 -Release  # optimised build
.\scripts\dev.ps1 -Verbose  # debug logging
.\scripts\dev.ps1 -SkipBuild # run last build without rebuilding

Or directly:

cd apps/desktop-tauri && pnpm run tauri:dev

Fast Windows Release Build

For repeat release builds on a Windows server, prefer the cached release script:

.\scripts\windows-release-build.ps1 -Ref v0.27.4

It builds from a clean managed checkout but keeps Cargo output, the pnpm store, and signed installer bootstrapper downloads in C:\code\Win-CodexBar-release\cache. Release assets land in C:\code\Win-CodexBar-release\assets. Keep the .sha256 sidecars; they are the copy/paste source for Winget's InstallerSha256.

Useful release flags:

.\scripts\windows-release-build.ps1 -Ref vX.Y.Z -WarmCacheOnly
.\scripts\windows-release-build.ps1 -Ref vX.Y.Z -SmokeInstall
.\scripts\release-doctor.ps1 -Version X.Y.Z

windows-release-build.ps1 only builds and smoke-tests. It has no upload switch. The hosted release path is the approval-gated CircleCI workflow documented in docs/release/ci-cd.md; publication uses its no-clobber, SHA-256-checked draft publisher.

macOS Windows Cross Build

For a fast compile check from macOS, use the cross-build wrapper:

./scripts/macos-windows-cross-build.sh

Or call the desktop package script directly:

pnpm --dir apps/desktop-tauri run tauri:build:windows-cross

This uses cargo-xwin plus Homebrew llvm/lld to build the Windows MSVC Tauri executable at target/x86_64-pc-windows-msvc/release/codexbar-desktop-tauri.exe. It is useful for catching frontend, Tauri, and Windows-target Rust compile failures from a Mac. It does not replace the Windows server release path: installer packaging, tray behavior, WebView2, DPAPI, startup integration, and smoke install validation still need a real Windows machine.

Project Structure

Win-CodexBar/
├── apps/desktop-tauri/          # Tauri desktop shell
│   ├── src/                     # React frontend (TypeScript)
│   └── src-tauri/               # Tauri/Rust backend
│       └── src/
│           ├── commands/        # Tauri IPC commands
│           ├── shell/           # Window management, DWM, tray bridge
│           └── main.rs          # App entry point
├── rust/                        # Shared backend crate + CLI
│   └── src/
│       ├── providers/           # Per-provider fetch/parse/auth
│       ├── core/                # Provider IDs, cost pricing
│       ├── browser/             # Browser cookie extraction (DPAPI)
│       ├── tray/                # Tray icon rendering
│       └── main.rs              # CLI entry point
├── docs/                        # Documentation
└── scripts/                     # Dev/release helper scripts

Documentation map

Doc Contents
ARCHITECTURE.md Modules, entry points, data flow (Windows/Tauri)
CLI.md codexbar.exe commands
CONFIGURATION.md Config paths, codexbar config, settings tabs
PROVIDERS.md Provider factory and sources
COOKIES.md Browser cookie import (DPAPI)
WSL.md WSL limitations
WINDOWS_PROOF.md Manual/runtime proof checklist
release/ci-cd.md Hosted PR check + local release
../AGENTS.md Agent/contributor guidelines

Upstream macOS docs (steipete/CodexBar) are a read-only concept source. Do not copy Swift/Keychain/Sparkle instructions here without a Windows rewrite.

Running Tests

# Shared crate tests
cargo test --manifest-path rust/Cargo.toml

# Tauri crate tests
cargo test --manifest-path apps/desktop-tauri/src-tauri/Cargo.toml

# TypeScript type check
cd apps/desktop-tauri && pnpm exec tsc --noEmit

# Lint
cargo clippy --all-targets -- -D warnings
cargo fmt --all --check