Install ProtoPeek

> v0.6.1 is the current stable release. The default resolver installs it from immutable GitHub release > assets and never falls back to a prerelease.

Install through an owned package channel

Homebrew on macOS or Linux installs both protopeek and pp, plus both manpages:

brew install shreyam1008/tap/protopeek

Scoop on Windows installs both executable shims from the owned bucket:

scoop bucket add shreyam https://github.com/shreyam1008/scoop-bucket
scoop install shreyam/protopeek

The formula and manifest pin release archives by SHA-256 and declare aria2 as a package dependency. Check the manifest for its packaged version; the direct resolver selects latest stable. Update with brew upgrade protopeek or scoop update protopeek; uninstall with brew uninstall protopeek or scoop uninstall protopeek.

Install through the release resolver

curl -fsSL https://raw.githubusercontent.com/shreyam1008/ProtoPeek/master/install.sh | sh

The installer verifies the selected archive against the matching checksums.txt before extraction. It provides protopeek and the short pp command unless an unrelated pp already occupies the install directory; that file is never overwritten. Older verified archives that contain only protopeek are supported by deriving the alias from that verified binary.

v0.6.1 Windows x64 archives bundle pinned aria2 1.37.0 inside the executable. It is extracted only when Downloader starts and no configured or PATH engine exists. Linux, macOS, Windows ARM64 and Windows 32-bit need installed aria2. Other workspaces do not start the transfer engine.

Windows PowerShell installs per user and updates the user PATH without requiring administrator access:

irm https://raw.githubusercontent.com/shreyam1008/ProtoPeek/master/install.ps1 | iex

To inspect the script first:

irm https://raw.githubusercontent.com/shreyam1008/ProtoPeek/master/install.ps1 -OutFile install.ps1
Get-Content .\install.ps1
.\install.ps1

Install a pinned release

The Windows PowerShell 5.1 and PowerShell 7 compatible per-user installer adds a ProtoPeek Start-menu shortcut. It opens the browser and minimizes the console. The shortcut uses loopback port 8844, keeping the browser origin stable so drafts and appearance survive a restart. Use -UIPort to choose another port if it is occupied, or -NoShortcuts for a CLI-only installation. -ShortcutDir supports a custom Start-menu destination. A shortcut pointing at a different installation is preserved. The console process remains the server: closing the browser leaves downloads running; stopping the server requires queue recovery on next start. Reopen the existing browser address while the server is running instead of starting a second copy.

The bundled engine adds about 2.36 MiB compressed to Windows x64 builds. Its upstream Windows TLS implementation does not support TLS 1.3-only servers; configure another aria2 build if needed. Source and notices are documented in internal/bundledaria2/README.md and accompany the release.

The installers accept a pinned immutable tag:

PROTOPEEK_VERSION=v0.6.1 sh -c "$(curl -fsSL https://raw.githubusercontent.com/shreyam1008/ProtoPeek/master/install.sh)"

$env:PROTOPEEK_VERSION = 'v0.6.1'
irm https://raw.githubusercontent.com/shreyam1008/ProtoPeek/master/install.ps1 | iex

Nightly builds

Every successful push build from main or master refreshes the single Nightly prerelease. It carries the latest development work without changing stable v0.6.1, GitHub Latest, Homebrew, Scoop, or a numbered stable version. Nightly is opt-in and may contain regressions. No scheduled build runs when the source has not changed. Failed builds do not promote a new binary.

Windows PowerShell (also works from System32):

$env:PROTOPEEK_CHANNEL = 'nightly'
Remove-Item Env:PROTOPEEK_VERSION -ErrorAction SilentlyContinue
try {
    irm https://raw.githubusercontent.com/shreyam1008/ProtoPeek/master/install.ps1 | iex
} finally {
    Remove-Item Env:PROTOPEEK_CHANNEL -ErrorAction SilentlyContinue
}

macOS / Linux:

curl -fsSL https://raw.githubusercontent.com/shreyam1008/ProtoPeek/master/install.sh | PROTOPEEK_CHANNEL=nightly PROTOPEEK_VERSION= sh

A pinned PROTOPEEK_VERSION overrides the channel, which is why these examples clear it. Subsequent pp update or protopeek update commands follow the installed Nightly channel. Use --channel stable to return to stable; stable v0.6.1 does not include the updater yet. Legacy PROTOPEEK_CHANNEL=edge remains supported, but Edge is now published manually. Stable resolution never falls back to either preview channel.

Upgrade from the CLI or UI (new on Nightly)

These commands are included in Nightly builds, not the v0.6.1 stable binary. Existing older installs need one installer run to obtain them. Then either name works:

pp update
protopeek update --check
pp update --channel nightly
protopeek update --channel stable

Without a channel flag, the updater follows the running release's stable, nightly or legacy edge channel. Stable checks never fall back to edge and never silently downgrade a newer stable version. An explicit preview-to-stable switch can remove preview features. Nightly and Edge compare the source revision, since its version tag is reused.

Open Settings → Updates for installed version/platform, release notes, an update-available notice and a checked release preview. Checking contacts GitHub only when requested. Installation requires a separate confirmation. Cancel stops checking or downloading; once file replacement starts, it completes or rolls back safely.

Direct installs download a size-bounded official archive, verify SHA-256, validate both Go executables, and stage replacements beside the install directory. An installation lock prevents concurrent updaters; stale previews and changed archives require a fresh check. Both protopeek and the owned pp are replaced; an unrelated pp is preserved. No shell installer runs, no privilege escalation is attempted, and browser/host preferences and transfer files are not changed. Existing manpages are maintained by the original installer.

Homebrew, Scoop, detected system packages, Go-install paths, Nix, Snap and container images keep their own ownership. The CLI/UI shows the applicable manager command instead of replacing managed files. A read-only direct install must be updated by its installation owner.

Restart required: existing servers keep their current code and active transfers. Finish or pause work, stop the old process, then run pp or protopeek again; reloading the browser alone does not restart the server. Windows may retain previous executable backups in the reported .protopeek-update-* directory while old processes are running. Remove that exact backup directory after those processes exit. A failed replacement rolls back; if rollback is blocked, the error identifies retained recovery files. After a crash mid-replacement, stop old processes and rerun the verified installer to repair the pair.

Upgrade and rollback

Upgrade a package-manager installation with brew upgrade protopeek or scoop update protopeek. To switch to a pinned rollback, first uninstall that package through the same manager so command paths do not conflict.

For a release-resolver installation, repeat the verified install for the target version. To roll back, set PROTOPEEK_VERSION to the previous tag and rerun the matching installer after stopping ProtoPeek. Launch on loopback and reconnect a non-production target before normal use.

Saved launcher targets live in the local browser profile. Back up browser site data before a major launcher migration.

Uninstall

For package-manager installs, use brew uninstall protopeek or scoop uninstall protopeek. For a Unix release-resolver install, remove protopeek, the ProtoPeek-owned pp, .protopeek-install, and the protopeek.1 and pp.1 files from the configured install/man directories. For a PowerShell release-resolver install, remove %LOCALAPPDATA%\Programs\ProtoPeek and remove that directory from the user PATH. Never remove an unrelated pp command. Browser-saved targets remain until cleared through browser site-data controls.

For the Windows installer, also remove the owned %APPDATA%\Microsoft\Windows\Start Menu\Programs\ProtoPeek\ProtoPeek.lnk shortcut (or the custom shortcut location). The PATH entry is the bin directory inside the installation.

Docker

No public container image is claimed. Build the local development image, then keep its published host port on loopback:

make docker
docker run --rm -p 127.0.0.1:8080:8080 protopeek:dev

The image's -allow-non-loopback-bind flag permits its container-interface listener but keeps browser requests limited to loopback Hosts and matching Origins. It is distinct from -unsafe-allow-remote, which disables that guard and requires an authenticated, TLS-terminated, rate-limited boundary.