Installation

portrm is a native Rust binary (~1.2MB) with zero runtime dependencies. It runs on macOS, Linux, and Windows.

Try Without Installing

npx portrm scan

This downloads a temporary copy and runs it. No global install needed.

npm

Best for Node.js developers:

npm install -g portrm

The npm package wraps the prebuilt native binary for your platform. No compilation needed.

Homebrew

Best for macOS and Linux users:

brew install abhishekayu/tap/portrm

pip

Best for Python developers:

pip install portrm

Cargo

Build from source (requires Rust toolchain):

cargo install portrm

Shell Script

One-line install for macOS and Linux:

curl -fsSL https://raw.githubusercontent.com/abhishekayu/portrm/main/install.sh | sh

Scoop (Windows)

For Windows users:

scoop bucket add portrm https://github.com/abhishekayu/scoop-portrm
scoop install portrm

VS Code Extension

For VS Code users who want a GUI:

code --install-extension abhishekayu.portrm-cli

Or search "portrm" in the VS Code Extensions marketplace. The extension auto-installs the CLI binary.

Verify Installation

ptrm --version
# portrm 2.2.0

Supported Platforms

Updating

Use the same package manager you installed with:

# npm
npm update -g portrm

# Homebrew
brew upgrade portrm

# pip
pip install --upgrade portrm

# Cargo
cargo install portrm

Uninstall

# npm
npm uninstall -g portrm

# Homebrew
brew uninstall portrm

# pip
pip uninstall portrm

# Cargo
cargo uninstall portrm

Next: View all commands