jyw-images-to-docx

Assemble all images in a workspace directory into a Word document with one

image per page (A4, 0.5-inch margins). Each page optionally reserves a ruled

writing area at the bottom for handwritten annotations.

Supported Formats

PNG · JPG/JPEG · GIF · BMP · SVG

Core Script

scripts/create_doc.js — Node.js script (requires the docx npm package).

Prerequisites

The docx npm package must be installed globally (one-time setup):

npm install -g docx

Skip this step if docx is already listed in npm ls -g --depth=0.

Usage

Basic Usage

node scripts/create_doc.js "<WORKSPACE_DIR>"

Important: NODE_PATH

Set NODE_PATH to the global node_modules directory so that the

skill script can resolve the docx package:

NODE_PATH="$(npm root -g)" node scripts/create_doc.js "<WORKSPACE_DIR>"

Request Parameters

Examples

# Basic usage
node scripts/create_doc.js "/path/to/workspace"

# Custom output file
node scripts/create_doc.js "/path/to/workspace" "/path/to/workspace/output.docx"

# Full options: custom output, 3 lines per page, 75% image height
node scripts/create_doc.js "/path/to/workspace" "/path/to/workspace/output.docx" 3 0.75

Output

The script generates a .docx file containing all images from the workspace,

one image per page, with optional ruled writing lines at the bottom of each page.

Images are sorted alphabetically by filename. Images that cannot have their

dimensions parsed fall back to 800×600.

Report to the user:

• Full path of the generated .docx file
• Number of pages / images included
• Any images that were skipped (unsupported format or unreadable file)

Post-Generation Behavior

When running in WorkBuddy: Do NOT call open_result_view or deliver_attachments after generating the .docx file. Simply report the result to the user in text (file path, page count, skipped images). This avoids triggering WorkBuddy's artifact download panel.

When running in other AI agents, follow their normal file presentation conventions.

Notes

• Unless the user explicitly requests specific values for output_file, writing_lines, or image_ratio, always use the script's built-in defaults (omit those arguments entirely). Do NOT override defaults on your own.
• The docx package should be installed globally (npm install -g docx). Do NOT install it locally in the workspace.
• The script already handles image discovery (scanning the workspace directory for supported formats). Do NOT pre-scan or count images before running the script — just execute it directly.
• To change the number of writing lines per page, pass a different writing_lines value.