Share what you are working on

showme

Give a local website, a single file, or an entire directory a temporary public URL.

Install

Install the showme client with Homebrew on macOS or Linux:

brew tap laetho/showme
brew trust --formula laetho/showme/showme
brew install showme

Later, update it with brew update && brew upgrade showme.

Begin

showme makes something on your computer available at a temporary public address. Use it to share a work in progress, preview a website, send a file, or browse a folder without deploying anything.

showme -showme-url https://showme.mattilsynet.io localhost:8080

Open or share the URL printed by the command. Keep showme running while the URL is in use, then press Ctrl-C when you are finished.

Recipes

A local web application

showme -showme-url https://showme.mattilsynet.io http://localhost:3000

A password-protected session

showme -showme-url https://showme.mattilsynet.io -basic-auth localhost:3000

showme creates a fresh password for this share and prints a URL in the form https://showoff:password@…. Anyone opening it must provide those credentials.

A single file

showme -showme-url https://showme.mattilsynet.io ./report.pdf

Pass the path directly. The file is available at both / and /report.pdf. file:// URLs remain supported.

A directory

showme -showme-url https://showme.mattilsynet.io ./site/

Every file inside the directory is made available at its relative path. An index.html becomes the front page; otherwise showme supplies a simple file listing.

Useful options

Advanced setup

Save this Showme service URL once so you do not need to pass -showme-url each time:

showme config set showme_url https://showme.mattilsynet.io

After that, invoking showme only requires what you want to share:

showme localhost:3000
showme ./report.pdf
showme ./site/

Use -showme-url or SHOWME_URL whenever you need to override the saved URL.

Notes on exposure

Anyone who has the URL can reach what you share unless you use -basic-auth or the local application has its own sign-in. Do not publish private material unintentionally.

The public address works only while the showme client remains running. Files added to a shared directory after startup appear only after restarting the command.