shepherdjs.dev valid

Shepherd.js

Shepherd is an open-source JavaScript library for building guided product

Their llms.txt

The beginning of the file, from our validated copy saved 2026-10-26T04:52:32.518Z. Cached copy · Source on shepherdjs.dev

# Shepherd.js

> Shepherd is an open-source JavaScript library for building guided product
> tours, user onboarding flows, trainings, and feature announcements on any
> website or web app. Steps render as accessible dialogs (keyboard navigation,
> focus trapping, aria attributes) that attach to DOM elements and are
> positioned by Floating UI. Works with React, Ember, Angular, Vue.js,
> ES Modules, or plain JavaScript. Free for open-source, personal, and
> non-commercial use (AGPL-3.0); commercial licenses are available.

## When to use Shepherd

Use Shepherd when a project needs to guide users through a web interface:

- Onboarding new users with a step-by-step walkthrough of an app
- Announcing or explaining new features in context
- Guiding users through complex forms, wizards, or multi-step workflows
- Building in-app training or self-serve product education
- Highlighting one or more DOM elements with a modal overlay while explaining them

How to use it: install with `npm install shepherd.js`, then in a module
`import Shepherd from 'shepherd.js'` and load the stylesheet
`shepherd.js/dist/css/shepherd.css` (import it, or link it from a stylesheet
tag). Create a `new Shepherd.Tour({ ... })`, add steps with
`tour.addStep({ title, text, attachTo, buttons })`, then call `tour.start()`.
`shepherd.mjs` is an ES module with a default export and does not define a
global `Shepherd`, so import it rather than loading it from a plain script tag.
It runs entirely in the browser; no backend service is required.

Shepherd is not a native mobile (iOS/Android) tour library and is not an
analytics product — it renders and orchestrates the tour UI itself.

## Docs

- [Documentation](https://docs.shepherdjs.dev/): installation, guides, API reference
- [Homepage in markdown](https://www.shepherdjs.dev/index.md): overview, install, quick example
- [Pricing and licensing](https://www.shepherdjs.dev/pricing): free plan, commercial licenses

## Code

- [GitHub repository](https://github.com/shipshapecode/shepherd): source, issues, releases
- [npm package](https://www.npmjs.com/package/shepherd.js): shepherd.js

## Company

- [About](https://www.shepherdjs.dev/about): who maintains Shepherd
- [Contact](https://www.shepherdjs.dev/contact): email, GitHub, Discord
- [Privacy](https://www.shepherdjs.dev/privacy): privacy policy
- [Ship Shape](https://shipshape.io/): the consultancy that maintains Shepherd

## Optional

- [Blog](https://www.shepherdjs.dev/blog): announcements and articles
- [Sitemap](https://www.shepherdjs.dev/sitemap-index.xml)

Related sites

Explore similar publishers →

Category suggestions: other listed sites in Developer tools. These share a category. See the whole category →

Machine-readable: GET /v1/resolve?q=shepherdjs.dev · GET /v1/domain/shepherdjs.dev · this page as Accept: application/json or text/markdown · MCP lookup_domain

Automatically discovered from public files. Inclusion does not imply endorsement or publisher participation.

Claim my listing on Agent Web Map for shepherdjs.dev:
1. POST https://agentwebmap.com/v1/sites/shepherdjs.dev/claims and keep claim_id and claim_secret private.
2. Publish the verification line "AgentWebMap verification: <token>" (token from step 1) in https://shepherdjs.dev/llms.txt, or use the DNS, meta-tag or well-known method the response describes. This only verifies the listing; your website and domain remain yours.
3. POST https://agentwebmap.com/v1/sites/shepherdjs.dev/verify with {"claim_id": "...", "claim_secret": "..."}.
4. Save the api_key from the answer; it manages the listing (PATCH https://agentwebmap.com/v1/sites/shepherdjs.dev).
MCP equivalent: tools begin_ownership_claim, then verify_domain, at https://agentwebmap.com/mcp. Docs: https://agentwebmap.com/docs#verify

Corrections or removal requests: contact the directory.