Skip to content

Commit 6728f5f

Browse files
Clarify web quick start with release link and two launch paths
1 parent 7684b49 commit 6728f5f

1 file changed

Lines changed: 28 additions & 9 deletions

File tree

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,38 @@ Or start a session in the web UI and manage it from any browser. Use Tailscale t
3030

3131
## ⚡ Quick Start (Download Web and Run)
3232

33-
If you are using GitHub workflow artifacts (and not GitHub Releases), use this path:
33+
Download:
34+
- Preferred (when a tagged release exists): [Download latest release](https://github.com/Intelligence-Factory-LLC/Buffaly.CodexEmbedded/releases/latest)
35+
- If GitHub shows no releases: open [Actions release workflow](https://github.com/Intelligence-Factory-LLC/Buffaly.CodexEmbedded/actions/workflows/release.yml), open the latest successful run, then download artifact `release-win-x64-<version>`.
3436

35-
1. Open **Actions** in this repo.
36-
2. Open the latest successful `release` workflow run.
37-
3. In **Artifacts**, download `release-win-x64-<version>`.
38-
4. Extract the downloaded zip.
39-
5. Open `apps\web` in the extracted folder.
40-
6. Run `Buffaly.CodexEmbedded.Web.exe`.
41-
7. Open the URL shown in the terminal after `Now listening on:`.
37+
### 2. Install, then launch web by command (recommended)
38+
39+
1. Extract the downloaded zip.
40+
2. Open PowerShell in the extracted folder.
41+
3. Run:
42+
43+
```powershell
44+
powershell -NoProfile -ExecutionPolicy Bypass -File .\install.ps1
45+
```
46+
47+
4. Open a new terminal and run:
48+
49+
```powershell
50+
buffaly-codex-web
51+
```
52+
53+
5. Open the URL shown after `Now listening on:`.
54+
55+
### 1. Run web exe directly (no install)
56+
57+
1. Extract the downloaded zip.
58+
2. Open `apps\web`.
59+
3. Run `Buffaly.CodexEmbedded.Web.exe`.
60+
4. Open the URL shown after `Now listening on:`.
4261

4362
Notes:
4463
- You still need `codex` CLI installed and authenticated for session start.
45-
- This quick start launches web directly without running installer wrappers.
64+
- Option 2 creates `buffaly-codex-web` and other helper commands.
4665

4766
## ✨ Major Features
4867

0 commit comments

Comments
 (0)