# Shepherd

JavaScript library for guiding users through a web app with product tours and onboarding steps.


Source: https://findsoftware.frbit.cloud/shepherd/
Last reviewed: 2026-11-16
Listed since: 2026-11-16

## Record

### Links

- home: https://www.shepherdjs.dev/
- repository: https://github.com/shipshapecode/shepherd
- docs: https://docs.shepherdjs.dev/guides/install/
- pricing: https://shepherdjs.dev/pricing
- discord: https://discord.gg/EGcDW5NSud

### Identity

- status: active
- maintainer: Ship Shape
- maintainerType: unknown
- parent: unknown
- firstRelease: 2014
- hqCountry: unknown

### Kind

- category: ui-library
- hosting: not applicable
- language: javascript
- runtime: unknown
- runtimeMin: not applicable
- basedOn: unknown

### Content

- contentStore: not applicable
- databases: not applicable
- adminUi: not applicable
- headlessApi: not applicable
- templating: not applicable
- i18n: not applicable

### Rendering and deploy

- runsAs: browser
- renderingModes: not applicable
- installMethod: npm, script tag, download

### License

- licenseModel: open-core
- license: AGPL-3.0, Commercial License

### Releases

- currentMajor: 16
- latestReleaseDate: 2026-11-11

### Adoption

- githubStargazers: 13833
- packagistDownloads: not applicable
- npmWeeklyDownloads: 439508
- contributors: 109
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 834
- dependentPackages: 43

### Sources

- urls: https://www.shepherdjs.dev/ (read 2026-11-16)
- urls: https://api.github.com/repos/shipshapecode/shepherd (read 2026-11-16)
- urls: https://docs.shepherdjs.dev/guides/install/ (read 2026-11-16)
- urls: https://www.shepherdjs.dev/pricing (read 2026-11-16)
- category: https://github.com/shipshapecode/shepherd/blob/main/README.md (read 2026-11-16)
- language: https://api.github.com/repos/shipshapecode/shepherd (read 2026-11-16)
- installMethod: https://github.com/shipshapecode/shepherd/blob/main/README.md (read 2026-11-16)
- installMethod: https://docs.shepherdjs.dev/guides/install/ (read 2026-11-16)
- installMethod: https://docs.shepherdjs.dev/guides/install/ (read 2026-11-16)
- runsAs: https://www.shepherdjs.dev/privacy (read 2026-11-16)
- license: https://github.com/shipshapecode/shepherd/blob/main/LICENSE.md (read 2026-11-16)
- license: https://github.com/shipshapecode/shepherd/blob/main/LICENSE.md (read 2026-11-16)
- maintainer: https://www.shepherdjs.dev/about (read 2026-11-16)
- firstRelease: https://api.github.com/repos/shipshapecode/shepherd/releases (read 2026-11-16)
- currentMajor: https://registry.npmjs.org/shepherd.js/latest (read 2026-11-16)
- latestReleaseDate: https://registry.npmjs.org/shepherd.js (read 2026-11-16)
- githubStargazers: https://api.github.com/repos/shipshapecode/shepherd (read 2026-11-16)
- contributors: https://api.github.com/repos/shipshapecode/shepherd/contributors?per_page=1 (read 2026-11-16)
- npmWeeklyDownloads: https://api.npmjs.org/downloads/range/2026-11-01:2026-11-07/shepherd.js (read 2026-11-16)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/shepherd.js (read 2026-11-16)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/shepherd.js (read 2026-11-16)

## Notes

Shepherd is a JavaScript library that guides users through a web app with product tours and onboarding steps: dialogs attach to elements in the interface, highlight them with a modal overlay and walk users through what to do next. The library runs in the browser of the application that embeds it. Its core works without a framework, and the project lists wrappers for React, Angular, Vue and Ember.

A page can load Shepherd from npm or pull a release from the jsDelivr CDN, and each GitHub release carries the built files.

## Worth knowing

The library is dual-licensed. Open-source, personal and non-commercial use fall under AGPL-3.0, and commercial use needs a commercial license that the project sells on its pricing page.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0
