Skip to content

Commit 8be4909

Browse files
from main to dev (#32)
* Add updater progress bar * Add updater progress bar (#24) * Dev (#25) * Add updater progress bar * Update overlay desktop icon assets * Dev (#26) * Add updater progress bar * Update overlay desktop icon assets * Add overlay delete confirmation dialog * Dev (#27) * Add updater progress bar * Update overlay desktop icon assets * Add overlay delete confirmation dialog * Make Windows install one-click * Sp/make windows install one click (#29) * added overlay iamge * Make Windows install one-click * Handle npm notices in Windows installer * added overlay iamge (#30) * Export portable Node runtime for Windows install * Fix Windows installer build and runtime * docs: clarify Windows install flows * Refine overlay dock icon size --------- Co-authored-by: Puneet Bhatt <codydeny@gmail.com>
1 parent bb5a166 commit 8be4909

3 files changed

Lines changed: 29 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,18 @@ curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superp
4141
curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.cmd && install-superplan.cmd
4242
```
4343

44+
### Windows (Git Bash / MINGW64)
45+
46+
```bash
47+
curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.cmd && cmd.exe //c install-superplan.cmd
48+
```
49+
50+
`install-superplan.cmd` is a Windows batch file. If you download it from Git Bash, run it through `cmd.exe` or switch to PowerShell; do not ask Bash to execute it directly.
51+
4452
The Windows installer now installs the CLI and the packaged overlay companion, and it downloads and keeps a bundled Node runtime when needed so users do not need to preinstall Node.js just to get started.
4553

4654
After install, Superplan will ask if you want to run `superplan init`.
55+
If `superplan` is not found in the current shell after install, open a new terminal and run `superplan --version`.
4756

4857
---
4958

context/context.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,21 @@ The current documented top-level command surface is:
4242

4343
Supported install paths in the current repo are:
4444

45-
- curl installer: `curl -fsSL https://raw.githubusercontent.com/superplan-md/superplan-plugin/0.1.0/scripts/install.sh | SUPERPLAN_REF=0.1.0 sh`
46-
- curl installer with custom prefix: `curl -fsSL https://raw.githubusercontent.com/superplan-md/superplan-plugin/0.1.0/scripts/install.sh | SUPERPLAN_REF=0.1.0 SUPERPLAN_INSTALL_PREFIX="$HOME/.local" sh`
45+
- macOS/Linux curl installer: `curl -fsSL https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.sh | sh`
46+
- Windows PowerShell: `curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.cmd; if ($LASTEXITCODE -eq 0) { .\install-superplan.cmd }`
47+
- Windows Command Prompt: `curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.cmd && install-superplan.cmd`
48+
- Windows Git Bash / MINGW64: `curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.cmd && cmd.exe //c install-superplan.cmd`
4749
- npm from a local checkout after build (release mode): `npm install -g .`
4850
- npm link for active local development: `npm link` from the project root after `npm run build`.
4951

5052
Important install note:
5153

52-
- Public quick-start docs pin the installer to `0.1.0` by using both the tagged raw URL and `SUPERPLAN_REF=0.1.0`, because `scripts/install.sh` otherwise resolves to the current default install ref when that env var is absent.
53-
- `scripts/install.sh` records install metadata under `~/.config/superplan/install.json` so `superplan update` can reuse the install source later and then refresh existing skill installs.
54+
- Public quick-start docs use the raw installer entrypoints from `main`: `scripts/install.sh` for macOS/Linux and `scripts/install.cmd` for Windows, with the Windows batch entrypoint delegating to `scripts/install.ps1`.
55+
- `install-superplan.cmd` is a Windows batch file; Git Bash users must hand it to `cmd.exe` instead of asking Bash to execute it directly, or they will hit `bash: install-superplan.cmd: command not found`.
56+
- The install scripts record install metadata under `~/.config/superplan/install.json` so `superplan update` can reuse the install source later and then refresh existing skill installs.
5457
- Older installed binaries that predate the `update` command still need one manual rebuild/reinstall before `superplan update` becomes available.
5558
- The documented npm flow assumes a local checkout where dependencies are installed and `npm run build` has been run before `npm install -g .`.
59+
- If the installer adds a new bin directory to `PATH`, users need to open a new shell before `superplan` is available there.
5660

5761
## Project Structure
5862

docs/release-checklist.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,18 @@ On Windows PowerShell:
5656
curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.cmd; if ($LASTEXITCODE -eq 0) { .\install-superplan.cmd }
5757
```
5858

59+
On Windows Command Prompt:
60+
61+
```cmd
62+
curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.cmd && install-superplan.cmd
63+
```
64+
65+
On Windows Git Bash / MINGW64:
66+
67+
```bash
68+
curl.exe -fsSL -o install-superplan.cmd https://raw.githubusercontent.com/superplan-md/superplan-plugin/main/scripts/install.cmd && cmd.exe //c install-superplan.cmd
69+
```
70+
5971
## Expected Unsigned Warnings
6072

6173
This release flow does not include Apple notarization or Windows code signing yet.

0 commit comments

Comments
 (0)