Reading the repo

Opening the box…

How to install Piik on Linux (TNTcraftHIM/Piik) · gitmanual

How to install on Linux

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,108
Activity: Updated this month
License: MIT
Open issues: 6
Got it running: Be the first
Looked up: 4 h ago

Saved setup from 4 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 Linux

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

Checking for

macOS Windows Linux

Install on your Android / TV device

Piik v2.5.3 · 11/3/2026 ↗

This app runs on the device, not on your Linux 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 · 641 downloads

Download

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

Download for Linux

Piik v2.5.3 · 11/3/2026 ↗

piik-f2f9d27-linux-arm64-runtime.tar.gz

tar.gz · ARM64 · 13.6 MB · 12 downloads · best match

Download

Move the extracted binary onto your PATH (e.g. /usr/local/bin).

curl -LO "https://github.com/TNTcraftHIM/Piik/releases/download/v2.5.3/piik-f2f9d27-linux-arm64-runtime.tar.gz"
tar -xzf "piik-f2f9d27-linux-arm64-runtime.tar.gz"

Other Linux downloads (2)

piik-app-linux-amd64.zip

zip · x64 · 37.1 MB · 80 downloads

Download

Move the extracted binary onto your PATH (e.g. /usr/local/bin).

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

piik-app-linux-arm64.zip

zip · ARM64 · 33.9 MB · 15 downloads

Download

Move the extracted binary onto your PATH (e.g. /usr/local/bin).

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

Did you get it running?

No reports for Linux yet.

Still stuck? Ask an AI

Opens a chat with this manual already filled in, for Linux. It uses your own account; gitmanual sends nothing.

Ask Claude Ask ChatGPT

Parts list

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

19× settings in .env

PUBLIC_BASE_URL
STUN_URLS
MAX_VIEWERS_PER_ROOM
SITE_ACCESS_PASSWORDsecret
LISTEN_HOST
PORT
ALLOWED_ORIGINSoptional
TLS_SELF_SIGNEDoptional
TLS_CERT_FILEoptional
TLS_KEY_FILEsecretoptional
ROOM_DATABASE_PATHoptional
ROOM_EMPTY_TIMEOUT_SECONDSoptional
ENDPOINT_MEDIA_COPY_CAPACITYoptional
SFU_UDP_PORToptional
SFU_LISTEN_HOSToptional
SFU_PUBLIC_IPoptional
SFU_ONLYoptional
STUN_LISTEN_HOST
NAT_PREDICTION_ENABLEDoptional

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

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/TNTcraftHIM/Piik/badge.svg)](https://gitmanual.com/TNTcraftHIM/Piik)

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