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:
Terminal
npm install -g @reshot/cli
Or with pnpm:
Terminal
pnpm add -g @reshot/cli
Or with yarn:
Terminal
yarn global add @reshot/cli
Verify Installation
Check that Reshot is installed correctly:
Terminal
reshot --version
Quick Setup
The CLI includes a unified setup command that handles everything:
Terminal
reshot setup
What this does:
- Authenticates: Links your local environment to the Reshot Platform (optional if using BYOS)
- Initializes: Creates a
docsync.config.jsonfile if one doesn't exist - 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:
Terminal
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:
Terminal
reshot auth
Credentials are stored securely in ~/.reshot/config.json.
Authentication is only required if you're using Platform Mode. For BYOS (Bring Your Own Storage), you can skip this step.
Next Steps
Now that you have Reshot installed, continue to the Quick Start guide to capture your first visual.