Skip to main content

Quick Install

Install the Sher skill for your AI agent:
npx skills add sherdotsh/sher
This command installs the sher-deploy skill, which teaches agents how to use the Sher CLI to deploy frontend projects and return live preview URLs.

What the Skill Does

The Sher skill provides your AI agent with:
  • Knowledge of Sher commands — how to run sher link and when to use deployment flags
  • Framework detection — understanding of which frameworks Sher supports
  • Output parsing — how to extract preview URLs from CLI output
  • Error handling — troubleshooting common deployment issues
  • Best practices — when to deploy, how to present URLs to users

Prerequisites

Before installing the skill, ensure:
1

Node.js installed

The skill requires Node.js and npm to be available in the agent’s environment
2

Skills CLI available

Your agent framework must support the skills ecosystem for skill installation

Installation Steps

1

Run the install command

Execute the skill installation command:
npx skills add sherdotsh/sher
This downloads and registers the Sher deployment skill with your agent.
2

Verify installation

The skill is now available to your agent. No additional configuration is needed.
3

Install Sher CLI (optional)

For better performance, install Sher globally in the agent’s environment:
npm i -g shersh
This allows the agent to use sher link directly instead of npx shersh link.

How Agents Use the Skill

Once installed, your agent can deploy projects automatically. Here’s the typical workflow:

Example Agent Workflow

# Agent scaffolds a new Vite + React project
npm create vite@latest my-app -- --template react
cd my-app
npm install

# Agent deploys the project
sher link

# Output:
#   sher — share your work
#
#   framework  Vite
#   building   npm run build
#
#   files      12 files (194KB)
#   uploading  ✓
#
#   https://a8xk2m1p.sher.sh  (copied)
#   expires 3/5/2026, 11:00 AM

# Agent extracts URL and presents to user:
# "Your app is live at https://a8xk2m1p.sher.sh"

Deployment Options

The skill teaches agents to use these flags appropriately:
--dir
string
Deploy a specific directory (skips framework detection)
sher link --dir ./dist
--ttl
number
Set link expiration in hours
sher link --ttl 2
--no-build
flag
Skip the build step if project is already built
sher link --no-build
--pass
string
Password-protect the preview (Pro tier only)
sher link --pass mysecret

Parsing URLs from Output

The skill teaches agents to extract preview URLs using this pattern:
https://[a-z0-9]{8}\.sher\.sh
All Sher preview URLs follow this format: an 8-character alphanumeric subdomain on sher.sh.

Presenting URLs to Users

The skill includes best practices for presenting deployed URLs:
Your preview is live at https://a8xk2m1p.sher.sh

Troubleshooting

Ensure Node.js and npm are installed and accessible in the agent’s environment. The skills CLI requires npm to download and install skill packages.
Install Sher globally in the agent environment:
npm i -g shersh
Alternatively, the agent can use npx shersh link instead of sher link.
The project exceeds the upload size limit:
  • Anonymous: 10 MB max
  • Authenticated: 50 MB max
  • Pro: 100 MB max
The agent should optimize build output or suggest authentication for larger projects.
The build didn’t produce output in the expected location. The agent should:
  1. Check that a build script exists in package.json
  2. Verify the build completed successfully
  3. Use --dir to specify the output directory explicitly if needed

Configuration

No additional configuration is required after skill installation. The skill is self-contained and works immediately.

Optional: Authentication

For better rate limits (25 links/day instead of 1), agents can authenticate with GitHub:
sher login
Authentication is persistent and survives across agent sessions.

Supported Frameworks

The skill includes knowledge of all supported frameworks:

Vite

Auto-detects Vite projects and builds to dist/

Next.js

Configures static export automatically, builds to out/

Astro

Detects Astro projects and builds to dist/

Create React App

Builds CRA projects to build/
The skill also supports any project with a build script that produces dist/, build/, or out/ directories.

Next Steps

Link Command

Learn about deployment command options and flags

Agent Overview

Understand AI agent integration capabilities

List Command

View and manage active deployments

Authentication

Set up GitHub authentication for better limits

Build docs developers (and LLMs) love