@hocuspocus/cli 3.2.2 → 3.2.4

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@hocuspocus/cli",
 	"description": "a CLI tool to start a local Hocuspocus server",
-	"version": "3.2.2",
+	"version": "3.2.4",
 	"homepage": "https://hocuspocus.dev",
 	"keywords": [
 		"hocuspocus",
@@ -18,11 +18,12 @@
 		"src"
 	],
 	"dependencies": {
-		"@hocuspocus/extension-logger": "^3.2.2",
-		"@hocuspocus/extension-sqlite": "^3.2.2",
-		"@hocuspocus/extension-webhook": "^3.2.2",
-		"@hocuspocus/server": "^3.2.2",
-		"meow": "^13.0.0"
+		"@hocuspocus/extension-logger": "^3.2.4",
+		"@hocuspocus/extension-s3": "^3.2.4",
+		"@hocuspocus/extension-sqlite": "^3.2.4",
+		"@hocuspocus/extension-webhook": "^3.2.4",
+		"@hocuspocus/server": "^3.2.4",
+		"meow": "^14.0.0"
 	},
 	"gitHead": "b3454a4ca289a84ddfb7fa5607a2d4b8d5c37e9d"
 }

package/src/index.js

@@ -1,6 +1,7 @@
 #!/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";
@@ -15,6 +16,11 @@ export const cli = meow(
     --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
@@ -22,6 +28,14 @@ export const cli = meow(
     $ 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,
@@ -41,6 +55,26 @@ export const cli = meow(
 				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: "",
+			},
 		},
 	},
 );
@@ -66,12 +100,48 @@ export const getConfiguredSQLiteExtension = () => {
 	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),
 });