Add build script
This commit is contained in:
30
README.md
30
README.md
@@ -1,7 +1,7 @@
|
||||
**Background Vision Agent (Windows)**
|
||||
|
||||
- One-command setup/run: `powershell -ExecutionPolicy Bypass -File .\run.ps1`
|
||||
- Requires Python 3.9+. Configure your API key in `bg_agent/config.py` or via the `OPENAI_API_KEY` env var.
|
||||
- Requires Python 3.11+ for source-based run. Configure your API key in `bg_agent/config.py` or via the `OPENAI_API_KEY` env var.
|
||||
- Runs hidden (uses `pythonw.exe`) and listens for global hotkeys.
|
||||
|
||||
**Hotkeys**
|
||||
@@ -44,4 +44,30 @@
|
||||
|
||||
- Before hosting, open `bootstrap-old.ps1` if you need customization (`$RepoUrl`, `$ZipUrl`, etc.). The `bootstrap.ps1` uses the default ZIP URL and destination directory and is designed specifically for `iwr ... | iex` usage.
|
||||
|
||||
- bootstrap-old will probably will be removed in the future
|
||||
- bootstrap-old will probably will be removed in the future
|
||||
|
||||
**Run Without Python (Binary Fallback)**
|
||||
|
||||
- The bootstrap now prefers a prebuilt EXE when requested or when Python is missing.
|
||||
- Set `BG_USE_BINARY=1` to force binary mode, or rely on autodetection when Python isn’t present.
|
||||
- By default it downloads from:
|
||||
`https://git.meoww.cc/admin/openai-code-script-poc/raw/branch/master/bin/BgVisionAgent.exe`
|
||||
- Override with `BG_BINARY_URL` to point to your own hosting.
|
||||
|
||||
Example:
|
||||
```
|
||||
$env:BG_USE_BINARY = '1'
|
||||
iwr -useb https://git.meoww.cc/admin/openai-code-script-poc/raw/branch/master/bootstrap.ps1 | iex
|
||||
```
|
||||
|
||||
Note: Some global hotkey features (keyboard hook) might require running the EXE as Administrator.
|
||||
|
||||
**Build Your Own EXE (Windows)**
|
||||
|
||||
- Requirements: Windows, Python 3.11 or 3.12, PowerShell.
|
||||
- Command:
|
||||
```
|
||||
powershell -ExecutionPolicy Bypass -File scripts\build-win.ps1
|
||||
```
|
||||
- Output: `dist\BgVisionAgent.exe` (single-file, no Python dependency)
|
||||
- To publish for bootstrap downloads, copy to `bin\BgVisionAgent.exe` in this repo (or upload elsewhere and set `BG_BINARY_URL`).
|
||||
|
||||
Reference in New Issue
Block a user