0 Fork 0

Files

T

AAA 1332473513 feat: rename product and runtime to Piik

Rename the active product, Go module, binaries, configuration, protocols and documentation to Piik while retaining the TV mascot and existing media/room behavior.

Use one current private contract without old-name aliases. Preserve SQLite authority and copy compatible local settings once; other settings start fresh. Git-message cleanup and the infrastructure name cutover are coordinated with this phase, with original history and deployment data archived externally.

Validated locally with Web and Go checks, Windows capture compilation, matched Client/Server builds, packaged Client control handshake and history-rewrite integrity checks. Skip duplicate hosted CI for this owner-authorized local release.

[skip ci]

2026-09-10 11:10:12 +08:00

3.5 KiB

Raw Blame History

Piik

English | 简体中文

Share your screen. Bring your friends.

Piik is private screen sharing for one Host and up to 20 invited friends. Friends watch in their browsers, with no installation.

flowchart LR
  Browser[Browser] --> Host[Host a room]
  Client[Piik Client] --> Host
  Host -->|Invite link| Friends[Friends watch in browsers]

Join a friend

Open the invitation your friend sent.
Press Play if your browser asks. Use the video's sound and fullscreen controls.

Got a room code instead? Open the same Piik site and choose Join a room. Site access and the room's password settings still apply.

Open the Piik site your group uses. Enter its site password if asked.
Choose Start sharing, pick a screen, window or tab, and check the sound switch.
Send the room's invitation link to your friends. Keep the sharing tab open.

Capture needs HTTPS or localhost; available sources and sound depend on the browser and platform. English, Chinese and an illustrated visual mode share the same controls, with light and dark themes.

Start your own room with Client

With a Client package for your platform:

Extract the whole package, keeping runtime beside the executable.
Open piik-client.exe on Windows, Piik Client.app on macOS, or ./piik-client on Linux.
Choose a mode, pick what to share, and send the invitation. Keep Client running.

Mode	Use it for
Local room	Friends on the same local network. An optional site password controls access.
Public invite	A temporary Internet invitation. The link lasts for this Client run; media remains P2P.
Connect to Site	An existing Piik site, with Client capture and media capabilities available in the same browser UI.

Client opens your system browser. Its package includes the Go application and capture/link helpers; running it needs no Node.js, npm or Go installation. Linux native capture uses the system Portal, PipeWire and GStreamer stack. See the Client guide for platform details.

Temporary public links use Cloudflare Quick Tunnel, which has no uptime guarantee. Media needs a working UDP path; restrictive networks or browser/OS suspension can interrupt sharing. Windows Client and Browser are the current acceptance focus; macOS/Linux physical capture checks remain separate. See current status for candidate and release readiness.

Host a site or contribute

The Server package is one Go executable with the Web UI embedded. It owns room signaling, STUN and optional embedded SFU fallback. Follow the self-hosting guide to set up your own site.

For source builds, tests and architecture, start with the documentation map. Contributing covers the workflow.

Something went wrong?

Include your version, OS/browser, expected result and steps to reproduce. For a local report, start Client with --debug and press D, or add ?debug=1 before any # in the Browser page URL and use its header download button. Review reports before sharing; see diagnostics and export. Connection trouble? Try the Chromium WebRTC FAQ.

License

Piik-owned code is MIT licensed. Third-party components retain their own licenses and notices: licensing guide.

3.5 KiB Raw Blame History