Github url


by shipshapecode

shipshapecode /shepherd

Guide your users through a tour of your app

8.4K Stars 503 Forks Last release: about 1 month ago (v8.0.1) MIT License 1.3K Commits 168 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Shepherd.js Logo

Ship Shape **Shepherd is maintained by Ship Shape. Contact us for web app consulting, development, and training for your project**.

npm version Download count all timenpm npm bundle sizeBuild StatusMaintainabilityTest CoverageStackShare

Guide your users through a tour of your app

Browsers support

| IE / EdgeEdge | FirefoxFirefox | ChromeChrome | SafariSafari | | --------- | --------- | --------- | --------- | | Edge| last 2 versions| last 2 versions| last 2 versions


API documentation




We encourage contributions of all kinds. If you would like to contribute in some way, please review our guidelines for contributing.


MIT License

Projects Using Shepherd

Here we showcase some of the awesome libraries built using Shepherd.

JS Framework Wrappers


Ember addon for the site tour library Shepherd


An Angular wrapper for the site tour library Shepherd


A React wrapper for the site tour library Shepherd


A Vue wrapper for the site tour library Shepherd

Rails gems


Rails engine that generates and tracks Shepherd tours within an application

Websites and Apps


SimplePlanner uses Shepherd to help new users get familiar with its collaborative scheduling approach. You do need to sign up via OAuth or email to see the scheduling tour. Check out the Envato Tuts+ Startup Series on its codebase which describes how Simple Planner was built.


Brokermate uses Shepherd to guide users through initial setup steps.

Your Project Here

If you have a cool open-source library built on Shepherd, PR this doc.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.