auto-updates

Author: stephanos

.github/workflows/release.yml

@@ -30,4 +30,5 @@ jobs:
       - name: Run release script
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SPARKLE_PRIVATE_ED_KEY: ${{ secrets.SPARKLE_PRIVATE_ED_KEY }}
         run: bash scripts/release.sh "$GITHUB_REF_NAME"

.gitignore

@@ -6,3 +6,4 @@ xcuserdata/
 DerivedData/
 .swiftpm/
 .netrc
+sparkle_private_key

Package.resolved

@@ -12,9 +12,21 @@ let package = Package(
       targets: ["AgentTally"]
     )
   ],
+  dependencies: [
+    .package(url: "https://github.com/sparkle-project/Sparkle", from: "2.9.1")
+  ],
   targets: [
     .executableTarget(
-      name: "AgentTally"
+      name: "AgentTally",
+      dependencies: [
+        .product(name: "Sparkle", package: "Sparkle")
+      ],
+      linkerSettings: [
+        .unsafeFlags([
+          "-Xlinker", "-rpath",
+          "-Xlinker", "@executable_path/../Frameworks",
+        ])
+      ]
     )
   ]
 )

Package.swift

@@ -4,7 +4,7 @@
 
 `AgentTally` is a standalone macOS menu bar app for tracking AI agent spending.
 
-Right now, only Claude Code is supported. The app shows your Claude Code spend for today and the current month, and refreshes every 60s.
+The app shows Claude Code and Codex spend for today and the current month, and refreshes every 60s.
 
 <p align="center">
   <img src="docs/menu-bar.png" alt="AgentTally menu bar screenshot">
@@ -25,6 +25,9 @@ Then:
 
 On first launch, macOS may ask you to confirm opening the app.
 
+AgentTally checks GitHub Releases for updates once per day and includes a
+`Check for Updates...` menu item.
+
 ## Development
 
 To build from source, you need:
@@ -49,3 +52,17 @@ mise run dev
 ```
 
 `mise` manages the Bun toolchain for this project and uses the system Swift toolchain. The build tasks install the local `ccusage` dependency, compile the helper, and stage both binaries into `AgentTally.app`.
+
+## Releases
+
+Release archives are signed for Sparkle updates with an EdDSA key. For local
+releases, the private key is read from the macOS Keychain. For GitHub Actions,
+set `SPARKLE_PRIVATE_ED_KEY` to the value exported by:
+
+```sh
+.build/artifacts/sparkle/Sparkle/bin/generate_keys -x sparkle_private_key
+```
+
+The app bundle is ad-hoc code signed by default so Sparkle can verify release
+archives without requiring an Apple Developer ID certificate. Set
+`CODESIGN_IDENTITY` to use a real signing identity later.

README.md

@@ -1,5 +1,6 @@
 import AppKit
 import Foundation
+import Sparkle
 
 @MainActor
 final class AppDelegate: NSObject, NSApplicationDelegate, NSMenuDelegate {
@@ -13,6 +14,11 @@ final class AppDelegate: NSObject, NSApplicationDelegate, NSMenuDelegate {
   private var lastSuccessfulAgentData: [AgentKind: AgentRawData] = [:]
   private var lastUsageDataFingerprints: [AgentKind: UsageDataFingerprint] = [:]
   private let loginItemManager = LoginItemManager()
+  private let updaterController = SPUStandardUpdaterController(
+    startingUpdater: true,
+    updaterDelegate: nil,
+    userDriverDelegate: nil
+  )
   private var startAtLoginViewState = StartAtLoginViewState.make(status: .notRegistered)
 
   func applicationDidFinishLaunching(_ notification: Notification) {
@@ -60,6 +66,11 @@ final class AppDelegate: NSObject, NSApplicationDelegate, NSMenuDelegate {
     refreshMenuIfNeeded()
   }
 
+  @objc
+  private func checkForUpdatesMenuItemSelected(_ sender: NSMenuItem) {
+    updaterController.checkForUpdates(sender)
+  }
+
   @objc
   private func quitMenuItemSelected() {
     NSApplication.shared.terminate(nil)
@@ -253,6 +264,8 @@ final class AppDelegate: NSObject, NSApplicationDelegate, NSMenuDelegate {
       return #selector(startAtLoginMenuItemSelected(_:))
     case .refresh:
       return #selector(refreshMenuItemSelected)
+    case .checkForUpdates:
+      return #selector(checkForUpdatesMenuItemSelected(_:))
     case .quit:
       return #selector(quitMenuItemSelected)
     }

Sources/AgentTally/App/AppDelegate.swift

@@ -9,6 +9,7 @@ public enum MenuCheckState: Equatable {
 public enum MenuActionKind: Equatable {
   case startAtLogin
   case refresh
+  case checkForUpdates
   case quit
 }
 
@@ -90,6 +91,9 @@ public enum MenuRowsBuilder {
     }
 
     rows.append(.separator)
+    rows.append(
+      .action(title: "Check for Updates...", kind: .checkForUpdates, keyEquivalent: "", state: .off)
+    )
     rows.append(
       .action(
         title: "Open at Login",

Sources/AgentTally/Presentation/MenuRowsBuilder.swift

@@ -107,6 +107,17 @@ func testMenuRowsBuilder() throws {
     "Codex not installed should not show spending section"
   )
 
+  try expect(
+    rows.contains(
+      .action(
+        title: "Check for Updates...",
+        kind: .checkForUpdates,
+        keyEquivalent: "",
+        state: .off
+      )
+    ),
+    "menu should contain update check action"
+  )
   try expect(
     rows.contains(
       .action(

Tests/MenuRowsHarness.swift

@@ -5,9 +5,18 @@ configuration="${1:-debug}"
 app_dir=".build/${configuration}/AgentTally.app"
 contents_dir="${app_dir}/Contents"
 macos_dir="${contents_dir}/MacOS"
+frameworks_dir="${contents_dir}/Frameworks"
 executable=".build/${configuration}/AgentTally"
 helper=".build/agenttally-usage-helper"
 plist_path="${contents_dir}/Info.plist"
+codesign_identity="${CODESIGN_IDENTITY:--}"
+sparkle_framework="$(
+  find .build/artifacts/sparkle/Sparkle/Sparkle.xcframework \
+    -type d \
+    -name Sparkle.framework \
+    -print \
+    -quit 2>/dev/null
+)"
 
 if [[ ! -x "${executable}" ]]; then
   echo "missing executable: ${executable}" >&2
@@ -19,9 +28,19 @@ if [[ ! -x "${helper}" ]]; then
   exit 1
 fi
 
+if [[ -z "${sparkle_framework}" || ! -d "${sparkle_framework}" ]]; then
+  echo "missing Sparkle.framework; run swift package resolve/build first" >&2
+  exit 1
+fi
+
 rm -rf "${app_dir}"
-mkdir -p "${macos_dir}"
+mkdir -p "${macos_dir}" "${frameworks_dir}"
 
 cp "${executable}" "${macos_dir}/AgentTally"
 cp "${helper}" "${macos_dir}/agenttally-usage-helper"
+ditto "${sparkle_framework}" "${frameworks_dir}/Sparkle.framework"
 bash scripts/generate_info_plist.sh "${plist_path}"
+
+codesign --force --sign "${codesign_identity}" "${macos_dir}/agenttally-usage-helper"
+codesign --force --sign "${codesign_identity}" "${macos_dir}/AgentTally"
+codesign --force --sign "${codesign_identity}" "${app_dir}"

scripts/bundle_app.sh

@@ -3,6 +3,8 @@ set -euo pipefail
 
 version="${AGENTTALLY_VERSION:-0.0.0-dev}"
 plist_path="${1:?output plist path required}"
+sparkle_feed_url="${SPARKLE_FEED_URL:-https://github.com/stephanos/agenttally-macos/releases/latest/download/appcast.xml}"
+sparkle_public_ed_key="${SPARKLE_PUBLIC_ED_KEY:-NUtyqJx9cL1Uf2b9gHKY3SzJbp/aizxf46tYylyIBBI=}"
 
 cat >"${plist_path}" <<EOF
 <?xml version="1.0" encoding="UTF-8"?>
@@ -29,6 +31,18 @@ cat >"${plist_path}" <<EOF
   <string>13.0</string>
   <key>LSUIElement</key>
   <true/>
+  <key>SUAllowsAutomaticUpdates</key>
+  <false/>
+  <key>SUAutomaticallyUpdate</key>
+  <false/>
+  <key>SUEnableAutomaticChecks</key>
+  <true/>
+  <key>SUFeedURL</key>
+  <string>${sparkle_feed_url}</string>
+  <key>SUPublicEDKey</key>
+  <string>${sparkle_public_ed_key}</string>
+  <key>SUScheduledCheckInterval</key>
+  <integer>86400</integer>
 </dict>
 </plist>
 EOF