Skip to main content

​
Requirements

Before installing Sher, make sure you have Node.js installed:
  • Node.js 16.x or higher (18.x or 20.x recommended)
Sher works with any package manager: npm, yarn, pnpm, or bun. The CLI will automatically detect which one your project uses.

​
Global Installation

Install Sher globally to use it across all your projects: 
npm install -g shersh
Global installation is recommended. You can run sher link from any project directory without installing it locally.

​
Local Installation

Alternatively, install Sher as a dev dependency in a specific project: 
npm install --save-dev shersh
Then use it via npm scripts or npx:
package.json
{
  "scripts": {
    "share": "sher link"
  }
}

npm run share
# or
npx sher link

​
Verify Installation

Check that Sher is installed correctly by running: 
sher --version
You should see the current version number (e.g., 0.4.9).
If the command is not found, make sure your global npm/yarn/pnpm bin directory is in your PATH. Run npm config get prefix to find the location.

​
Update Sher

To update Sher to the latest version: 
npm update -g shersh

​
Uninstall

To remove Sher from your system: 
npm uninstall -g shersh
Uninstalling will not delete your active deployments. They will continue to be accessible until they expire.

​
Supported Frameworks

Sher automatically detects and supports:
  • Vite (React, Vue, Svelte, Solid, etc.)
  • Next.js (static export, auto-configured)
  • Astro
  • Create React App
  • Custom projects with a build script and dist/, build/, or out/ directory
For Next.js projects, Sher automatically injects output: "export" into your next.config.js during the build. The original config is restored after the upload.

​
Next Steps

Now that Sher is installed, learn how to use it:

Quickstart Guide

Deploy your first project in under 60 seconds

Build docs developers (and LLMs) love

Get started for freeTalk to us