Tutorial: Install - Documentation

JS Framework Wrappers

We strive to make it easy to use Shepherd in all the major frameworks, and have written wrappers to facilitate this.

angular-shepherd
ember-shepherd
react-shepherd
vue-shepherd

Install Directly

npm

npm install shepherd.js --save

yarn

yarn add shepherd.js

pnpm

pnpm install shepherd.js --save

bun

bun add shepherd.js

styles

Don't forget to add your styles

import 'shepherd.js/dist/css/shepherd.css';

GitHub Releases

Whenever we release a new version, the contents of the dist are uploaded to the release in GitHub. You can find those assets here.

jsDelivr CDN

You can use jsDelivr to pull down any release from npm. For example, you could include v10.0.1 with styles in your app with:

<script src="https://cdn.jsdelivr.net/npm/shepherd.js@10.0.1/dist/js/shepherd.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/shepherd.js@10.0.1/dist/css/shepherd.css"/>