CliqRelay is an open-source platform that transforms page clicks and interactions into beautiful, step-by-step visual documentation. By coupling a native browser capture extension with a high-performance backend, CliqRelay tracks exact DOM interactions and contextual screenshots thereby instantly automating the heavy lifting of writing technical guides and docs. Capture and refine workflows instantly to help your teams perform at their best.
- Instant Capture: Capture workflows in real-time with a Chrome extension that listens for user interactions and captures them.
- Contextual Screenshots: Automatically capture screenshots during interactions to provide visual context.
- Seamless Sharing: Share guides with your team to ensure everyone has access to the best practices and workflows.
- AI-Powered Refinement: Use AI to automatically refine captured workflows into clear, step-by-step guides that are easy to follow and share. (coming soon)
You can run the full CliqRelay stack locally or on your own infrastructure.
Prerequisites:
- Docker and Docker Compose
1. Start the backend stack:
$ docker compose --env-file docker-compose.prod.env -f docker-compose.prod.yml down -v && \
docker compose --env-file docker-compose.prod.env -f docker-compose.prod.yml build --parallel && \
docker compose --env-file docker-compose.prod.env -f docker-compose.prod.yml up -d2. Build the browser extension and install it in Chrome:
Follow the apps/extension project's README for this step. This will enable you to run it as a local extension.
Your contributions are welcome! Here's how you can get involved:
- If you find a bug, please submit an issue.
- Set up your development environment by following our Contribution Guide.
- Contribute code by making a pull request to enhance features, improve user experience, or fix issues.
Join our growing community for support, discussions, and updates:
If you'd like to support the ongoing development of this project, consider subscribing on Polar!
