Skip to content

Add one-line install script; refresh README - #3

Merged
thepeak99 merged 1 commit into
masterfrom
docs/install-script
Jul 8, 2026
Merged

Add one-line install script; refresh README#3
thepeak99 merged 1 commit into
masterfrom
docs/install-script

Conversation

@thepeak99

Copy link
Copy Markdown
Member

What

Replaces the ugly multi-line install snippet with a proper installer and a single copy-paste command.

install.sh (new)

A POSIX sh script that:

  • Detects OS/arch (linux-amd64, macos-amd64, macos-arm64) and fails loudly on anything unsupported.
  • Resolves the matching asset from the /releases/latest API — version-agnostic, so it keeps working across future releases.
  • Downloads to a temp file (with cleanup trap), installs to BINDIR (default /usr/local/bin, sudo if needed, falls back to ~/.local/bin), warns if the target dir isn't on PATH.
  • Runs mail-cli install-skill automatically. Overridable via BINDIR=... and INSTALL_SKILL=0.

README

  • New one-liner (also the agent copy-paste prompt):
    curl -fsSL https://raw.githubusercontent.com/patch-notes/mail-cli/master/install.sh | sh
  • Dropped the dead PLAN.md link → points at AGENTS.md.
  • Fixed the License section (See repository → MIT).
  • Demoted cargo build/install to an optional "Build from source" note.

Testing

  • sh -n install.sh — clean.
  • Verified OS/arch detection + asset URL resolution on Linux: resolves the correct linux-amd64 release URL.

Note: the curl | sh raw URL works once this lands on master.

Co-authored by PeakBot!

- add install.sh: detects OS/arch, downloads the matching prebuilt binary
  from the latest GitHub release, installs to BINDIR (default /usr/local/bin,
  falls back to ~/.local/bin), then runs `mail-cli install-skill`
- README: replace the multi-line curl|grep|mv snippet with a single
  `curl -fsSL .../install.sh | sh`; add an agent copy-paste one-liner
- README: drop dead PLAN.md link (point at AGENTS.md), fix License to MIT

Co-authored by PeakBot!
@thepeak99
thepeak99 merged commit 9faed1f into master Jul 8, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant