Skip to content

Commit 067dae7

Browse files
committed
docs: switch macos install guidance to source
1 parent 08c3c87 commit 067dae7

5 files changed

Lines changed: 140 additions & 30 deletions

File tree

CODEBASE_DOCUMENTATION.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ FRONTEND: client/app.js, client/terminal.js - Web client
1717
NATIVE: src-tauri/src/main.rs - Native desktop app
1818
CONFIG: config.json, package.json - Configuration files
1919
GUIDES: CLAUDE.md, AGENTS.md - Repo workflow + release guardrails for contributors/agents
20+
DOCS: docs/MACOS_SIGNING_RELEASE_CHECKLIST.md - Maintainer checklist for Apple signing/notarization secrets and macOS desktop releases
2021
META: .github/FUNDING.yml - GitHub Sponsors button configuration
2122
PACKAGING: scripts/tauri/prepare-backend-resources.js - Bundles backend resources + reusable packaged prod deps
2223
scripts/tauri/run-tauri-build.js - Centralized Tauri build entrypoint (local Windows fast-cache pinning + profile dispatch)

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Agent Workspace
22

33
[![Website](https://img.shields.io/badge/Website-agent--workspace.ai-00d4ff?style=for-the-badge)](https://agent-workspace.ai)
4-
[![Download](https://img.shields.io/badge/Download-Latest%20Release-00d4ff?style=for-the-badge)](https://github.com/web3dev1337/agent-workspace/releases/latest)
4+
[![Releases](https://img.shields.io/badge/Releases-Latest-00d4ff?style=for-the-badge)](https://github.com/web3dev1337/agent-workspace/releases/latest)
55
[![Sponsor](https://img.shields.io/badge/Sponsor-GitHub%20Sponsors-ea4aaa?style=for-the-badge&logo=githubsponsors&logoColor=white)](https://github.com/sponsors/web3dev1337)
66
[![Follow on X](https://img.shields.io/badge/Follow-%40AIOnlyDeveloper-000000?style=for-the-badge&logo=x)](https://x.com/AIOnlyDeveloper)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge)](LICENSE)
@@ -91,7 +91,7 @@ Compatibility rule: if it can be launched from a terminal command in your worktr
9191
- **Task Integration** — Pull tasks from Trello and/or use local task records. GitHub Issues and Linear coming soon.
9292
- **Browser-like Tabs** — Multiple workspaces open simultaneously, each with its own terminals and state.
9393
- **Runs Locally** — Runs on your hardware. Access through the desktop app or the browser. No publisher-hosted telemetry by default.
94-
- **Desktop Apps**Native Tauri builds for Windows and macOS are published on the latest GitHub release.
94+
- **Desktop Apps**Windows desktop builds are published on the latest GitHub release. macOS users should run from source until the signed Apple desktop release path is restored.
9595

9696
## Tier System
9797

@@ -119,25 +119,23 @@ Get-AuthenticodeSignature .\downloaded-file.exe
119119

120120
### macOS
121121

122-
[Download the latest release](https://github.com/web3dev1337/agent-workspace/releases/latest) and grab the `.dmg` build.
123-
124-
Current macOS releases are packaged as Apple Silicon (`aarch64`) disk images. Open the `.dmg`, drag **Agent Workspace** into `Applications`, then launch it from there.
125-
126-
If Gatekeeper blocks the first launch, right-click the app and choose **Open**, or allow it in **System Settings -> Privacy & Security**.
127-
128-
Or run from source:
122+
Packaged macOS downloads are temporarily unavailable while Apple signing and notarization are being configured. For now, run Agent Workspace from source:
129123

130124
```bash
131125
git clone https://github.com/web3dev1337/agent-workspace.git
132-
cd agent-workspace && npm install
126+
cd agent-workspace
127+
npm install
133128
npm start
134129
```
135130

136-
### Mac / Linux / WSL
131+
Maintainers: see [docs/MACOS_SIGNING_RELEASE_CHECKLIST.md](docs/MACOS_SIGNING_RELEASE_CHECKLIST.md) before publishing the next macOS desktop release.
132+
133+
### Linux / WSL
137134

138135
```bash
139136
git clone https://github.com/web3dev1337/agent-workspace.git
140-
cd agent-workspace && npm install
137+
cd agent-workspace
138+
npm install
141139
npm start
142140
```
143141

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# macOS Signing Release Checklist
2+
3+
Use this before shipping another macOS desktop build.
4+
5+
## Why
6+
7+
Unsigned or un-notarized macOS downloads can be blocked by Gatekeeper with messages like:
8+
9+
- `Agent Workspace.app is damaged and can't be opened`
10+
- `Agent Workspace.app is from an unidentified developer`
11+
12+
The GitHub Actions macOS workflow now expects proper Apple signing and notarization credentials for tag releases.
13+
14+
## GitHub Actions Secrets
15+
16+
Add these repository secrets before cutting the next macOS release.
17+
18+
Required:
19+
20+
- `APPLE_CERTIFICATE`
21+
- `APPLE_CERTIFICATE_PASSWORD`
22+
23+
Optional but recommended:
24+
25+
- `APPLE_SIGNING_IDENTITY`
26+
27+
Choose one notarization path.
28+
29+
App Store Connect API key path:
30+
31+
- `APPLE_API_KEY`
32+
- `APPLE_API_ISSUER`
33+
- `APPLE_API_KEY_BASE64`
34+
35+
Apple ID path:
36+
37+
- `APPLE_ID`
38+
- `APPLE_PASSWORD`
39+
- `APPLE_TEAM_ID`
40+
41+
## Secret Formats
42+
43+
`APPLE_CERTIFICATE`
44+
45+
- export the `Developer ID Application` certificate as a `.p12`
46+
- base64-encode the file contents
47+
- store the base64 string in the secret
48+
49+
`APPLE_CERTIFICATE_PASSWORD`
50+
51+
- password used when exporting the `.p12`
52+
53+
`APPLE_API_KEY_BASE64`
54+
55+
- base64-encode the `.p8` App Store Connect API key file
56+
57+
`APPLE_SIGNING_IDENTITY`
58+
59+
- optional override
60+
- example: `Developer ID Application: Your Name (TEAMID)`
61+
62+
## Release Steps
63+
64+
1. Confirm the repo version is ready for release.
65+
2. Confirm the macOS secrets above are present in GitHub Actions.
66+
3. Push the release tag.
67+
4. Wait for `.github/workflows/macos.yml` to finish.
68+
5. Confirm the workflow passes the `Verify signed + notarized macOS bundle` step.
69+
6. Confirm the uploaded macOS `.app` and `.dmg` came from that signed workflow run.
70+
71+
## What the Workflow Now Verifies
72+
73+
The release workflow now:
74+
75+
- imports the Apple certificate into a temporary keychain
76+
- resolves the macOS signing identity
77+
- passes notarization credentials into the Tauri build
78+
- validates the built app with `codesign`
79+
- checks Gatekeeper acceptance with `spctl`
80+
- validates notarization stapling with `xcrun stapler validate`
81+
82+
If signing or notarization is not configured on a tag release, the macOS workflow fails before publishing assets.
83+
84+
## After Shipping
85+
86+
Test the released macOS artifact on a clean machine:
87+
88+
1. download the `.dmg` from GitHub Releases
89+
2. move the app into `Applications`
90+
3. launch it normally
91+
4. confirm Gatekeeper does not show a damaged/unidentified warning
92+
93+
## Source Install Fallback
94+
95+
Until a signed macOS desktop release is published, direct users to:
96+
97+
```bash
98+
git clone https://github.com/web3dev1337/agent-workspace.git
99+
cd agent-workspace
100+
npm install
101+
npm start
102+
```

site/index.html

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ <h1 class="mega-title">
108108
<a class="btn-glow download-btn download-windows" href="https://github.com/web3dev1337/agent-workspace/releases/latest" target="_blank">
109109
<span>Download for Windows</span>
110110
</a>
111-
<a class="btn-glow download-btn download-mac" href="https://github.com/web3dev1337/agent-workspace/releases/latest" target="_blank" style="display:none">
112-
<span>Download for Mac</span>
111+
<a class="btn-glow download-btn download-mac" href="#install-mid" style="display:none">
112+
<span>Install on Mac</span>
113113
</a>
114114
<a class="btn-glow download-btn download-linux" href="#install-mid" style="display:none">
115115
<span>Install on Linux</span>
@@ -248,20 +248,22 @@ <h2 class="section-title">Install</h2>
248248

249249
<div class="install-panel" id="tab-mac-mid">
250250
<div class="install-option">
251-
<a class="btn-glow install-download" href="https://github.com/web3dev1337/agent-workspace/releases/latest" target="_blank">Download for Mac (Apple Silicon)</a>
252-
</div>
253-
<p class="install-note">Download the <span class="text-cyan">.dmg</span>, open it, and drag Agent Workspace to Applications.</p>
254-
<div class="install-option" style="margin-top: 1.5rem">
255-
<span class="btn-outline install-download install-source-label">Or run from source ↓</span>
251+
<span class="btn-outline install-download install-source-label">Run from Source on Mac ↓</span>
256252
</div>
253+
<p class="install-note">Packaged macOS downloads are temporarily unavailable while Apple signing and notarization are being configured.</p>
257254
<div class="install-cmd">
258255
<code>git clone https://github.com/web3dev1337/agent-workspace.git</code>
259256
<button class="copy-btn" data-copy="git clone https://github.com/web3dev1337/agent-workspace.git">Copy</button>
260257
</div>
261258
<div class="install-cmd">
262-
<code>cd agent-workspace && npm install && npm start</code>
263-
<button class="copy-btn" data-copy="cd agent-workspace && npm install && npm start">Copy</button>
259+
<code>cd agent-workspace && npm install</code>
260+
<button class="copy-btn" data-copy="cd agent-workspace && npm install">Copy</button>
261+
</div>
262+
<div class="install-cmd">
263+
<code>npm start</code>
264+
<button class="copy-btn" data-copy="npm start">Copy</button>
264265
</div>
266+
<p class="install-note">Opens at <span class="text-cyan">http://localhost:9461</span> in your browser.</p>
265267
</div>
266268

267269
<div class="install-panel" id="tab-linux-mid">
@@ -461,20 +463,22 @@ <h2 class="section-title">Install</h2>
461463

462464
<div class="install-panel" id="tab-mac">
463465
<div class="install-option">
464-
<a class="btn-glow install-download" href="https://github.com/web3dev1337/agent-workspace/releases/latest" target="_blank">Download for Mac (Apple Silicon)</a>
465-
</div>
466-
<p class="install-note">Download the <span class="text-cyan">.dmg</span>, open it, and drag Agent Workspace to Applications.</p>
467-
<div class="install-option" style="margin-top: 1.5rem">
468-
<span class="btn-outline install-download install-source-label">Or run from source ↓</span>
466+
<span class="btn-outline install-download install-source-label">Run from Source on Mac ↓</span>
469467
</div>
468+
<p class="install-note">Packaged macOS downloads are temporarily unavailable while Apple signing and notarization are being configured.</p>
470469
<div class="install-cmd">
471470
<code>git clone https://github.com/web3dev1337/agent-workspace.git</code>
472471
<button class="copy-btn" data-copy="git clone https://github.com/web3dev1337/agent-workspace.git">Copy</button>
473472
</div>
474473
<div class="install-cmd">
475-
<code>cd agent-workspace && npm install && npm start</code>
476-
<button class="copy-btn" data-copy="cd agent-workspace && npm install && npm start">Copy</button>
474+
<code>cd agent-workspace && npm install</code>
475+
<button class="copy-btn" data-copy="cd agent-workspace && npm install">Copy</button>
476+
</div>
477+
<div class="install-cmd">
478+
<code>npm start</code>
479+
<button class="copy-btn" data-copy="npm start">Copy</button>
477480
</div>
481+
<p class="install-note">Opens at <span class="text-cyan">http://localhost:9461</span> in your browser.</p>
478482
</div>
479483

480484
<div class="install-panel" id="tab-linux">
@@ -511,7 +515,7 @@ <h2 class="section-title">Install</h2>
511515
</div>
512516
<div class="footer-links">
513517
<a href="https://github.com/web3dev1337/agent-workspace" target="_blank">GitHub</a>
514-
<a href="https://github.com/web3dev1337/agent-workspace/releases/latest" target="_blank">Download</a>
518+
<a href="https://github.com/web3dev1337/agent-workspace/releases/latest" target="_blank">Releases</a>
515519
<a href="https://github.com/web3dev1337/agent-workspace" target="_blank">Run from Source</a>
516520
<a class="footer-sponsor" href="https://github.com/sponsors/web3dev1337" target="_blank">Sponsor</a>
517521
<a href="terms.html">Terms</a>

site/llms-full.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,15 @@ Agent Workspace is an open-source, local-first orchestration layer for CLI codin
5858
### Windows (recommended)
5959
- Download: <https://github.com/web3dev1337/agent-workspace/releases/latest>
6060

61+
### macOS
62+
- Packaged macOS downloads are temporarily unavailable while Apple signing and notarization are being configured.
63+
- Use the source install flow below for now.
64+
6165
### Source
6266
```bash
6367
git clone https://github.com/web3dev1337/agent-workspace.git
64-
cd agent-workspace && npm install
68+
cd agent-workspace
69+
npm install
6570
npm start
6671
```
6772

0 commit comments

Comments
 (0)