snapshot of https://github.com/ueberdosis/hocuspocus.git @ cf3cfa355b4d3bb61c6b6c80071f71783e32470e (2026-09-15)

packages/cli/README.md

@@ -0,0 +1,18 @@
+# @hocuspocus/cli
+[![Version](https://img.shields.io/npm/v/@hocuspocus/cli.svg?label=version)](https://www.npmjs.com/package/@hocuspocus/cli)
+[![Downloads](https://img.shields.io/npm/dm/@hocuspocus/cli.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
+[![License](https://img.shields.io/npm/l/@hocuspocus/cli.svg)](https://www.npmjs.com/package/@hocuspocus/cli)
+[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
+
+## Introduction
+A CLI tool to start a local [Hocuspocus](https://github.com/ueberdosis/hocuspocus) server – useful for quickly spinning up a collaboration backend for development, demos, or simple deployments, with optional SQLite, S3, logger, and webhook extensions.
+
+```bash
+npx @hocuspocus/cli
+```
+
+## Official Documentation
+Documentation can be found in the [GitHub repository](https://github.com/ueberdosis/hocuspocus).
+
+## License
+Hocuspocus is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/hocuspocus/blob/main/LICENSE.md).

packages/cli/package.json

@@ -0,0 +1,35 @@
+{
+	"name": "@hocuspocus/cli",
+	"description": "a CLI tool to start a local Hocuspocus server",
+	"version": "4.7.0",
+	"homepage": "https://hocuspocus.dev",
+	"keywords": [
+		"hocuspocus",
+		"yjs",
+		"yjs-websocket"
+	],
+	"license": "MIT",
+	"type": "module",
+	"bin": {
+		"hocuspocus": "./src/index.js",
+		"@hocuspocus/cli": "./src/index.js"
+	},
+	"files": [
+		"src"
+	],
+	"dependencies": {
+		"@hocuspocus/extension-logger": "workspace:^",
+		"@hocuspocus/extension-s3": "workspace:^",
+		"@hocuspocus/extension-sqlite": "workspace:^",
+		"@hocuspocus/extension-webhook": "workspace:^",
+		"@hocuspocus/server": "workspace:^",
+		"meow": "^14.0.0"
+	},
+	"gitHead": "b3454a4ca289a84ddfb7fa5607a2d4b8d5c37e9d",
+	"repository": {
+		"url": "https://github.com/ueberdosis/hocuspocus"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

packages/cli/src/index.js

@@ -0,0 +1,150 @@
+#!/usr/bin/env node
+
+import { Logger } from "@hocuspocus/extension-logger";
+import { S3 } from "@hocuspocus/extension-s3";
+import { SQLite } from "@hocuspocus/extension-sqlite";
+import { Webhook } from "@hocuspocus/extension-webhook";
+import { Server } from "@hocuspocus/server";
+import meow from "meow";
+
+export const cli = meow(
+	`
+  Usage
+    $ hocuspocus [options]
+
+  Options
+    --port=, -p     Set the port, defaults to 1234.
+    --webhook=, -w  Configure a custom webhook.
+    --sqlite=, -s   Store data in a SQLite database, defaults to :memory:.
+    --s3            Store data in S3 or S3-compatible storage.
+    --s3-bucket=    S3 bucket name (required when using --s3).
+    --s3-region=    S3 region, defaults to us-east-1.
+    --s3-prefix=    S3 key prefix for documents.
+    --s3-endpoint=  S3 endpoint URL (for S3-compatible services like MinIO).
+    --version       Show the current version number.
+
+  Examples
+    $ hocuspocus --port 8080
+    $ hocuspocus --webhook http://localhost/webhooks/hocuspocus
+    $ hocuspocus --sqlite
+    $ hocuspocus --sqlite database/default.sqlite
+    $ hocuspocus --s3 --s3-bucket my-docs
+    $ hocuspocus --s3 --s3-bucket my-docs --s3-region eu-west-1
+    $ hocuspocus --s3 --s3-bucket my-docs --s3-endpoint http://localhost:9000
+
+  Environment Variables (for S3)
+    AWS_ACCESS_KEY_ID       AWS access key ID
+    AWS_SECRET_ACCESS_KEY   AWS secret access key
+    AWS_REGION              AWS region (alternative to --s3-region)
+`,
+	{
+		importMeta: import.meta,
+		flags: {
+			port: {
+				type: "string",
+				shortFlag: "p",
+				default: "1234",
+			},
+			webhook: {
+				type: "string",
+				shortFlag: "w",
+				default: "",
+			},
+			sqlite: {
+				type: "string",
+				shortFlag: "s",
+				default: "",
+			},
+			s3: {
+				type: "boolean",
+				default: false,
+			},
+			s3Bucket: {
+				type: "string",
+				default: "",
+			},
+			s3Region: {
+				type: "string",
+				default: "us-east-1",
+			},
+			s3Prefix: {
+				type: "string",
+				default: "",
+			},
+			s3Endpoint: {
+				type: "string",
+				default: "",
+			},
+		},
+	},
+);
+
+export const getConfiguredWebhookExtension = () => {
+	return cli.flags.webhook
+		? new Webhook({
+				url: cli.flags.webhook,
+			})
+		: undefined;
+};
+
+export const getConfiguredSQLiteExtension = () => {
+	if (cli.flags.sqlite) {
+		return new SQLite({
+			database: cli.flags.sqlite,
+		});
+	}
+	if (process.argv.includes("--sqlite")) {
+		return new SQLite();
+	}
+
+	return undefined;
+};
+
+export const getConfiguredS3Extension = () => {
+	if (!cli.flags.s3) {
+		return undefined;
+	}
+
+	const bucket = cli.flags.s3Bucket || process.env.S3_BUCKET;
+	if (!bucket) {
+		console.error(
+			"❌ S3 bucket is required. Use --s3-bucket or set S3_BUCKET environment variable.",
+		);
+		process.exit(1);
+	}
+
+	const config = {
+		bucket,
+		region: cli.flags.s3Region || process.env.AWS_REGION || "us-east-1",
+	};
+
+	if (cli.flags.s3Prefix) {
+		config.prefix = cli.flags.s3Prefix;
+	}
+
+	if (cli.flags.s3Endpoint) {
+		config.endpoint = cli.flags.s3Endpoint;
+		config.forcePathStyle = true;
+	}
+
+	if (process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY) {
+		config.credentials = {
+			accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+			secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
+		};
+	}
+
+	return new S3(config);
+};
+
+const server = new Server({
+	port: Number.parseInt(cli.flags.port, 10),
+	extensions: [
+		new Logger(),
+		getConfiguredWebhookExtension(),
+		getConfiguredSQLiteExtension(),
+		getConfiguredS3Extension(),
+	].filter((extension) => extension),
+});
+
+server.listen();