[opensourcedex]

Usertour is a free, open source customer support & success project written in TypeScript and released under a custom open-source licence. It has 2,305 GitHub stars, 158 forks and 30 open issues, and was last pushed 13 hours ago. On this registry it ranks #9 of 17 tracked projects in Customer Support & Success, with 5 head-to-head comparisons available. It gained 2 stars over the last 6 tracked days.

What is Usertour?

What it is

Usertour is an open-source user onboarding platform that lets teams build in-app product tours, checklists, launchers, tooltips, announcements, and surveys. It is written in TypeScript and published with a NOASSERTION license, and it lives in the browser-based onboarding ecosystem alongside commercial tools it explicitly positions itself against — Appcues, Userpilot, Userflow, Userguiding, and Chameleon. The repository carries the onboarding, checklist, surveys, tooltips, tour, nps, in-app, and announcements topics, and it points to usertour.io for the hosted site, documentation, and blog.

The concrete problem it solves is that producing onboarding experiences usually requires a paid third-party platform, and the resulting flows are locked inside that vendor. Usertour gives teams a self-deployable alternative that they can run on their own infrastructure, so they keep control of the data and the deployment. It also adds a built-in MCP server, so an AI assistant such as Claude Code, Cursor, or Codex can generate production-ready onboarding directly in a project, read the application's design system to match styling, and wire up the SDK when it is not installed.

Key capabilities

  • Builds in-app product tours, checklists, launchers, tooltips, announcements, and surveys from one tool.
  • Integrates with any application that runs in a browser, and supports both single-page applications and multi-page applications.
  • Offers advanced user targeting through custom user attributes and tracked events for segmenting and engaging audiences.
  • Ships a built-in MCP server at https://mcp.usertour.io/mcp that connects AI assistants to author onboarding flows.
  • Provides a Claude Code plugin through /plugin marketplace add usertour/skills and /plugin install usertour@usertour, with per-client connection guides for Cursor, Codex, VS Code, and ChatGPT.
  • Supports self-hosted instances by pointing the MCP client at the instance URL shown in Settings → MCP, exported as USERTOUR_MCP_URL.
  • Covers survey formats including feature ratings, overall satisfaction, usability feedback, and open-ended comments.

Who uses it and how

  • Product teams that want onboarding tours, checklists, and surveys without paying for Appcues, Userflow, or a comparable hosted product.
  • Teams that must keep onboarding data on their own infrastructure and therefore self-deploy the platform instead of using the hosted service.
  • Developers who describe a desired flow to an AI assistant through the MCP server and have the assistant generate the onboarding, matching the existing design system and installing the SDK.
  • Support and success teams that run in-app surveys to collect feature ratings, satisfaction scores, NPS, and open-ended feedback from users.
  • Teams that launch announcements and tooltips inside a single-page or multi-page web application and target them with custom attributes and tracked events.

Getting started

The README documents two paths: self-deployment with Docker, where you copy .env.example to .env,

project readme (upstream, from github) — read inline

Usertour: An alternative to: Appcues, Userpilot, Userflow, Userguiding, Chameleon , Etc...

Usertour is an open-source user onboarding platform. It allows you to create in-app product tours, checklists, and surveys in minutes—effortlessly and with full control.

Website | Documentation | Blog | Twitter | Discord

Static Badge Static Badge Discord Chat Static Badge

Quick Start

Self-deploy with Docker

Deploy your own feature-rich, unlimited version of Usertour using Docker.

To start deployment:

cp .env.example .env # make sure all required envs are properly set
docker compose up -d

Visit http://localhost:8011 to start using Usertour.

View details in Self-hosting.

One Click Deployment

Deploy on Railway

Local Development

View details in CONTRIBUTING.

✨ Build Your Onboarding with AI

Usertour ships a built-in MCP server: connect an AI assistant like Claude Code, Cursor or Codex, describe the experience you want, and it builds production-ready onboarding directly in your project — reading your app's design system to match the styling, and even wiring up the SDK on its own if it isn't installed yet.

Point any MCP client at the endpoint — it discovers the authorization flow on its own:

https://mcp.usertour.io/mcp

Using Claude Code? The plugin wires the MCP connection and the authoring skills in one:

/plugin marketplace add usertour/skills
/plugin install usertour@usertour

Per-client steps for Cursor, Codex, VS Code, ChatGPT and more: MCP connection guide.

Self-hosting? Use your own instance's URL instead — it's shown in Settings → MCP (for the Claude Code plugin, export it before launching):

export USERTOUR_MCP_URL="https://<your-usertour-host>/mcp"

Below: real prompts and the unedited results. Full walkthrough with every prompt — including AI-driven analytics — in Build Your Onboarding with AI.

🪄 "Build an onboarding flow for the Create Task feature"

Using Usertour, build a user onboarding flow for the Create Task feature.

Requirements:
1. The visual theme must match the website's existing design.
2. The flow must be production-ready and suitable for launch.
3. Every step should provide genuine value to users. Avoid adding steps
   simply for the sake of having a flow—the experience should help users
   understand and successfully use the feature.

📋 "Create a product feedback survey"

Create a survey to collect user feedback about the product's different
features, including:

* Feature ratings
* Overall satisfaction
* Usability feedback
* Suggestions for improvement
* Open-ended comments

The survey should be thoughtfully structured and suitable for production use.

🎬 "A modal that plays this YouTube video"

Create a one-step flow containing a modal that displays this YouTube video:

https://www.youtube.com/watch?v=ZIaOBAjvc38

Add supporting copy based on the theme:

Sam Altman: "Never a Better Time to Do a Startup"

The copy should briefly introduce the video, explain why it is relevant,
and encourage users to watch it.

Features

Usertour makes it easy to design in-app product tours, checklists, launchers, and surveys, enabling anyone to craft effective onboarding experiences. Our team is dedicated to consistently improving Usertour with frequent updates that include new features, bug fixes, and performance enhancements.

Easy Onboarding: Build Flows Fast with Simple Integration and Smart Targeting

  • 🌐 Compatible with all frameworks: If your app runs in a browser, it seamlessly integrates with Usertour.
  • 📄 Supports multi-page apps: Whether it's a single-page application or spans across multiple pages, Usertour fits perfectly.
  • 🎯 Advanced user targeting: Define custom user attributes and track events to segment and engage your audience effectively.

Built for professional workflows with version control and environments

  • 🛠️ Multiple environments supported: Manage environments like Production and Staging within a single Usertour account.
  • 🔄 Version tracking: Monitor every change in your flows, including who made adjustments and when.

Fully customizable appearance

  • 🎨 Tailor your design: Adjust text, button colors, font family, and size to match your branding.
  • 🖌️ Support for multiple themes: Create unique themes for different flows, offering flexibility for varied use cases.

Gain actionable insights with powerful analytics

  • 📊 Performance metrics: Track the effectiveness of your flows with detailed data on views and completion rates.
  • 🚨 Identify problem areas: Pinpoint steps causing user confusion or drop-offs and address the issues seamlessly.

How to Use?

  • Cloud
    • We've deployed a Usertour Cloud version that allows zero-configuration usage, offering all capabilities of the self-hosted version. Visit https://www.usertour.io/ to get started.
  • Self-hosting Usertour Community Edition
    • Get started quickly with our Self-hosting Guide to run Usertour in your environment. For more detailed references and in-depth instructions, please refer to our documentation.
  • Usertour for enterprise / organizations

Contributing Guidelines

| Bug Reports | Feature Requests | Issues/Discussions | Usertour Community | | --------------------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------

readme truncated — read the full docs on github

Frequently asked questions

Is Usertour free to use?

Usertour is open source. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does Usertour do?

Create engaging product tours and user onboarding experiences

What is Usertour written in?

Usertour is primarily written in TypeScript. Its source is publicly available at https://github.com/usertour/usertour, and it has 2,305 GitHub stars.