Phonemos User Guide

Migrate Word Documents

Wolf Art / Pexels

You can import Word documents (.docx) into Phonemos using the phonemos-cli-import command-line tool. The tool reads a folder structure from your file system and creates a matching hierarchy of pages in Phonemos.

Prerequisites

  • Java 18 or later installed

  • An import token from Phonemos (see step 1 below)

  • The phonemos-cli-import.jar file

How It Works

Organise your Word documents in a folder structure on your computer. The CLI tool will mirror that structure as pages in Phonemos:

  • Each subfolder becomes a page

  • Each .docx file becomes the content of a page

  • If a subfolder and a .docx file share the same name, the document provides the content for that folder's page

  • Other files (images, PDFs, etc.) are grouped into a Files section on the page

Temporary Word files (e.g. ~$document.docx) and system files (e.g. .DS_Store) are automatically ignored.

Steps

1. Get an Import Token

Open the settings menu in the top bar and choose Import from External System. Copy the import token — it looks like: phonemos:import:<site-id>:<hostname>/<secret>

2. Preview the Import (Optional)

Run a dry run to see what will be imported without making any changes:

1 2 3 4 java -jar phonemos-cli-import.jar upload \ --importToken=phonemos:import:... \ --path=/path/to/your/word/documents \ --upload.dryRun=true

3. Run the Import

1 2 3 java -jar phonemos-cli-import.jar upload \ --importToken=phonemos:import:... \ --path=/path/to/your/word/documents

The tool will display a plan of all pages to be created and ask for confirmation before proceeding. Once confirmed, it uploads all documents to Phonemos.

Example Folder Structure

The following folder structure:

1 2 3 4 5 6 docs/ ├── Introduction.docx ├── Getting Started.docx ├── Advanced.docx └── Advanced/ └── Configuration.docx

produces this page hierarchy in Phonemos:

1 2 3 4 5 docs/ ├── Introduction ├── Getting Started └── Advanced └── Configuration