Installation

Get the Reshot CLI installed and configured in minutes.

Prerequisites

• Node.js 18 or higher
• Chrome browser installed
• A terminal (macOS, Linux, or Windows with WSL)

Install the CLI

Install Reshot globally using npm:

npm install -g @reshot/cli

Or with pnpm:

pnpm add -g @reshot/cli

Or with yarn:

yarn global add @reshot/cli

Verify Installation

Check that Reshot is installed correctly:

reshot --version

Quick Setup

The CLI includes a unified setup command that handles everything:

reshot setup

What this does:

1. Authenticates: Links your local environment to the Reshot Platform (optional if using BYOS)
2. Initializes: Creates a docsync.config.json file if one doesn't exist
3. Launches Studio: Opens the local web interface at http://localhost:4300

Manual Initialization

If you prefer to set up manually, you can initialize a project with:

reshot init

This creates a basic docsync.config.json with default settings.

Authentication (Optional)

If you're using the Reshot Platform for managed storage, authenticate with:

reshot auth

Credentials are stored securely in ~/.reshot/config.json.

Next Steps

Now that you have Reshot installed, continue to the Quick Start guide to capture your first visual.