Command-line interface

Introduction

Sometimes, you just want to spin up a local Hocuspocus instance really fast. Maybe just to give it a try, or to test your webhooks locally. Our CLI brings Hocuspocus to your command line in seconds.

Execute once

npx @hocuspocus/cli
npx @hocuspocus/cli --port 8080
npx @hocuspocus/cli --webhook http://localhost/webhooks/hocuspocus
npx @hocuspocus/cli --sqlite

Global installation

npm install -g @hocuspocus/cli
hocuspocus --port 8080
hocuspocus --webhook http://localhost/webhooks/hocuspocus
hocuspocus --sqlite
yarn global add @hocuspocus/cli
hocuspocus --port 8080
hocuspocus --webhook http://localhost/webhooks/hocuspocus
hocuspocus --sqlite

Per-project installation

npm install @hocuspocus/cli
npx hocuspocus
npx hocuspocus --port 8080
npx hocuspocus --webhook http://localhost/webhooks/hocuspocus
npx hocuspocus --sqlite
yarn add @hocuspocus/cli
npx hocuspocus
npx hocuspocus --port 8080
npx hocuspocus --webhook http://localhost/webhooks/hocuspocus
npx hocuspocus --sqlite