Reading the repo

Opening the box…

How to set up Piik (TNTcraftHIM/Piik) · gitmanual

Assembly instructions

TNTcraftHIM/Piik

Free, open-source screen sharing for private live streams with friends. Watch together in a browser or self-host Piik. 免费开源的私密屏幕共享，支持游戏直播、一起看电影与自部署。

Node.jsViteGo#live-streaming#p2p#private-streaming#screen-sharing

Difficulty: Moderate
Time: about 15 min
Stars: ★ 4,062
Activity: Updated this month
License: MIT
Open issues: 5
Got it running: Be the first
Looked up: 2 h ago

Saved setup from 2 h ago

Start here

Website ↗piik.tvThe project's own site.

Setup script in the repo

The maintainers included scripts/install-hooks.sh. Run it from the cloned folder after reading it.

bash scripts/install-hooks.sh

Also: scripts/install-hooks.ps1

Will it work on my device?

Yes, it installs on your macOS

A ready-made macOS download is in the latest release.

Checking for

Install on your Android / TV device

Piik v2.5.3 · 11/3/2026 ↗

This app runs on the device, not on your macOS computer. Download it, then install it from the computer with adb (turn on ADB debugging in the device's Developer Options first).

piik-app-android-universal.apk

Android app · 51.0 MB · 226 downloads

Download

adb connect <device-ip>:5555
adb install -r "piik-app-android-universal.apk"

Download for macOS

Piik v2.5.3 · 11/3/2026 ↗

piik-app-darwin-arm64.zip

zip · Apple Silicon · 36.0 MB · 46 downloads · best match

Download

If it contains an .app, move it to Applications.

curl -LO "https://github.com/TNTcraftHIM/Piik/releases/download/v2.5.3/piik-app-darwin-arm64.zip"
unzip "piik-app-darwin-arm64.zip"

Other macOS downloads (1)

piik-app-darwin-amd64.zip

zip · Intel · 39.1 MB · 17 downloads

Download

If it contains an .app, move it to Applications.

curl -LO "https://github.com/TNTcraftHIM/Piik/releases/download/v2.5.3/piik-app-darwin-amd64.zip"
unzip "piik-app-darwin-amd64.zip"

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 10 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js 24.22.1runtime
1×Go 1.27.3runtime
1×npm npm@11.17.0package manager

19× settings in .env

LISTEN_HOST
PORT
PUBLIC_BASE_URL
ALLOWED_ORIGINS
TLS_SELF_SIGNED
TLS_CERT_FILE
TLS_KEY_FILEsecret
SITE_ACCESS_PASSWORDsecret
ROOM_DATABASE_PATH
ROOM_EMPTY_TIMEOUT_SECONDS
MAX_VIEWERS_PER_ROOM
ENDPOINT_MEDIA_COPY_CAPACITY
SFU_UDP_PORT
SFU_LISTEN_HOST
SFU_PUBLIC_IP
SFU_ONLY
STUN_URLS
STUN_LISTEN_HOST
NAT_PREDICTION_ENABLED

Featured in Zain Finds

See the poster ↗Amazing... the screen share goes straight to your friends? 😳

▶ Watch the Reel ↗Need to share your screen without making the other person install anything? 👀

Share this manual

Good to know

Several programs live in cmd/ (piik-app, piik-peer-gate, piik-server). Run one with go run ./cmd/<name>; the README says which is the app.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: internal/thirdparty/go-nat-pmp/go.mod, internal/thirdparty/go-nat/go.mod, native/probes/encoder-pool/CMakeLists.txt, site/docs/package.json

package.json scripts (31)

devnode scripts/package-licenses.mjs public/third-party-licenses.txt && vite
buildnpm run build:web
build:websitenode scripts/update-website-hero.mjs --check && tsx --tsconfig scripts/tsconfig.json scripts/update-guide-diagrams.tsx --check && node scripts/build-website.mjs
update:guide-imagesnode scripts/update-guide-images.mjs
preview:websitevite preview --outDir build/site --host 127.0.0.1 --port 18890
build:webnode scripts/package-licenses.mjs public/third-party-licenses.txt && node --input-type=module -e "import { readdirSync, rmSync } from 'node:fs'; const dir = 'internal/server/webassets/dist'; for (const entry of readdirSync(dir)) { if (entry !== '.gitkeep') rmSync(dir + '/' + entry, { recursive: true, force: true }); }" && vite build
package:appnode scripts/assemble-app.mjs
package:app-candidatenode scripts/package-app-candidate.mjs
check:gonode scripts/check-go.mjs
check:go-corenode scripts/check-go.mjs --core
check:go-vulngo run golang.org/x/vuln/cmd/govulncheck@v1.9.0 ./cmd/piik-app ./cmd/piik-server
check:go-racenode scripts/check-go.mjs --race
check:containernode scripts/check-container.mjs
check:nativenode scripts/check-go.mjs --capture-only
gate:app-mediatsx scripts/app-media-gate.ts
gate:network-labtsx scripts/network-lab.ts
gate:media-lifecycletsx scripts/media-lifecycle-gate.ts
gate:app-native-hosttsx scripts/app-native-host-gate.ts
gate:app-browser-fanouttsx scripts/app-browser-fanout-gate.ts
gate:embedded-sfutsx scripts/embedded-sfu-gate.ts
gate:room-voicetsx scripts/room-voice-gate.ts
gate:app-linktsx scripts/app-link-gate.ts
gate:peer-topology-loopbacktsx scripts/peer-assisted-benchmark.ts
gate:sfu-admissionvitest run tests/sfu-client.test.ts tests/route-transition.test.ts && go test ./internal/server/...
gate:access-privacynpm run build:web && tsx scripts/access-privacy-gate.ts

Files we read (10)

.env.example

.github/workflows/atomgit-mirror.yml

.github/workflows/repository-hygiene.yml

.github/workflows/website.yml

.node-version

CONTRIBUTING.md

README.md

deploy/container/.env.example

go.mod

package.json

Branch main · 1,178 files in the repo