Skip to content

Yumdocs CLI is the command line interface for Yumdocs, to automate Word, PowerPoint, and Excel documents.

License

Notifications You must be signed in to change notification settings

yumdocs/yumdocs-cli

Repository files navigation

yumdocs-cli

A command line interface for Yumdocs, a template engine for Word, PowerPoint and Excel.

Yumdocs Animation

Documentation

Yumdocs is fully documented at https://www.yumdocs.com.

License and Copyright

This project is MIT Licensed like its 3rd party components:

Copyright (c) 2022 - Jacques L. Chereau. All rights reserved.

Quick Start

Prerequisites

Download and install nodeJS v16+ from https://nodejs.org/.

Installation

Open a terminal window and run:

npm i -g @yumdocs/yumdocs-cli

Getting started

  1. Create a Word document named input.docx, type {{field}} and save it in the project directory.

  2. In the same project directory, create a file named data.json, and copy-paste:

{
  "field": "Anything you see fit"
}
  1. Open a terminal window in the project directory and run yumdocs input.docx data.json output.docx.

  2. output.docx has been generated and the {{field}} placeholder has been replaced with Anything you see fit.