← Directory

CliqRelay

CliqRelay is an open-source platform that automatically transforms browser clicks and interactions into beautiful, step-by-step visual documentation and…

  • Media Applications
  • Other
  • Productivity
  • Tools & Utilities
  • Web & Publishing
CliqRelay is an open-source platform that automatically transforms browser clicks and interactions into beautiful, step-by-step visual documentation and technical guides. By pairing a native browser extension with a high-performance backend, CliqRelay tracks exact DOM interactions and contextual screenshots, automating the heavy lifting of writing user manuals, onboarding documentation, and SOPs. Key Features: - Instant Capture: Record user workflows in real time using the CliqRelay Chrome/Firefox browser extension. - Contextual Screenshots: Automatically captures and crops screenshots for every click and interaction. - Live Recording Sidepanel: Start, pause, review, and watch steps populate live in the extension sidepanel. - Rich Guide Editor: Reorder steps, edit descriptions, blur sensitive details, and insert annotations (tips, callouts, alerts,

Platform availability

Available on 1 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

59/100 Fair

Maintained
100last commit 8 days ago
Popular
3241 GitHub stars
Easy to install
101 install platform
Light to run
No data

Based on 3 of 4 factors.

Availability: platform listings confirmed today

GitHub stars
41
Open issues
0
Last commit
2026-10-15
License
Apache-2.0
Activity
declining

Checked today - source: GitHub (CliqRelay/cliqrelay)

Resources & Compatibility

Requirements not published yet.

First-install notes

No first-install notes yet.

Alternatives

No alternatives collected yet.

Common questions

What command sequence starts the self-hosted CliqRelay backend?

Use Docker Compose with the production env file and production compose file to stop and remove volumes, build in parallel, and start the stack detached.

How do I run the browser extension with a self-hosted CliqRelay instance?

Build the extension from the apps/extension project and install it in Chrome. The extension README explains how to run it as a local extension.

Can I export captured guides from CliqRelay?

Any guide can be exported as a PDF for offline sharing or documentation handoff.

Can I edit captured steps after recording them?

In the web dashboard, you can reorder steps, edit titles and descriptions, and insert annotation blocks such as headers, tips, callouts, and alerts.

Does self-hosting let me keep documentation data on my own infrastructure?

Yes, you can deploy CliqRelay on your own infrastructure and keep the data under your control.

Answers sourced from github.com, www.cliqrelay.com

Community

No community discussions collected yet.