@fontoxml/fontoxml-development-tools/README.md

# fontoxml-development-tools [![NPM version](https://badge.fury.io/js/%40fontoxml%2Ffontoxml-development-tools.svg)](https://badge.fury.io/js/%40fontoxml%2Ffontoxml-development-tools)

The Fonto Development Tools are command-line tools which offer support for developers when configuring Fonto Editor instances and its complementary products, and facilitate running them locally for testing purposes. They act as a gateway to the Fonto SDK and can be used for creating and updating editor instances, and preparing XML schemas for use with Fonto.

## Installation

### Node

The tools require [NPM](https://www.npmjs.com/get-npm) on [Node.js®](https://nodejs.org/) version 12.20.x or higher, which are freely available. An active or maintenence LTS release is recommended. After installing Node.js, you can install the latest version of the Fonto Development Tools globally on your system using the following command:

    npm i -g @fontoxml/fontoxml-development-tools

Alternatively, the tools can be installed locally for your project using the following command:

    npm install --save-dev @fontoxml/fontoxml-development-tools

> **tip**: You can use Node Version Manager on Linux/MacOS or its Windows counterpart to install and use multiple version of Node.js on a single system. This is useful if you develop different projects with different versions of Node.js.

### Docker

Certain commands, like `review run` and `review build`, require [Docker Community Edition](https://www.docker.com/) to be installed.

> **tip**: Docker places their installers behind an unnecessary login. Use the following direct links to avoid having to create an account: [Windows installer](https://download.docker.com/win/stable/Docker%20for%20Windows%20Installer.exe), [macOS installer](https://download.docker.com/mac/stable/Docker.dmg). For Linux, Docker Community Edition is usually available through package managers.

## Usage

Get help for the available commands:

    fontoxml-development-tools --help

Get help for a specific command, detailing all its arguments:

    fontoxml-development-tools <command> --help

Output the current version:

    fontoxml-development-tools --version

Use the `fdt` shorthand instead of `fontoxml-development-tools`:

    fdt <command> --help

## Development license

Certain commands, like `editor`, `connectors` and `content-quality`, require a valid developer license file on your system and the permissions to run them. A license file `fonto.lic` can be stored in either of these locations:

-   In your user home directory (`$HOME` on linux/MacOS, or `%homepath%` on Windows).
-   In an ancestor folder of where you are running the `fdt` command.

Verify that your license file is installed correctly by running the `fdt license validate` command.

To obtain a license file, or to obtain additional permissions, please contact us at https://fontoxml.com/contact-us/ or reach out to your Fonto contact if you have one available. License files are personal and we disadvice to store them in any version control system you might have.

## Usage examples

### Licensing

Validate and update the currently installed license file:

    fdt license validate

### Schema

Output a table with information about all attributes in a schema:

    fdt attributes [--schema <schemaPath>] [--columns name ns use defaultvalue ...]

Output schema information about a specific attribute, including all its definitions:

    fdt attribute <attributeName> [--schema <schemaPath>]

Output a table with information about all elements in a schema:

    fdt elements [--schema <schemaPath>] [--columns name ns local desc atts ...]

Output schema information about a specific element, including detailed content model info:

    fdt element <elementName> [--schema <schemaPath>]

Output a table with information about all schemas:

    fdt schemas [--columns package locations path]

Output a table with information about all simple types in a schema:

    fdt simpletypes [--columns name variety format]

### Operations

Output a table with information about all operations in a repository:

    fdt operations [--columns name file label desc key ...]

Output information about a specific operation:

    fdt operation <operationName>

### Localization

Extract messages from packages and save them in a message bundle template:

    fdt localization extract [<output>] [--paths <package1> [<package2> ...]]

Merge multiple message bundles into a single bundle:

    fdt localization merge [<output>] --bundles <bundle1> <bundle2> [<bundle3> ...]

Update message bundle with a new template bundle:

    fdt localization update <output> <bundle> [--output-to-stdout]

Output a table with information about all messages in a message (template) bundle:

    fdt localization messages <bundle> [--search-in <search text>] [--search-out <search text>] [--search-package <search text>] [--search-file <search text>] [--with-conflicts] [--without-conflicts] [--with-out] [--without-out] [--no-table]

### Editor

Create a new instance of Fonto Editor:

    fdt editor init [<output>] [--version <version|'nightly'>] [--name <name>] [--schema <path>] [--add-ons <addonName> [<addonName> ...]] [--non-interactive]

Upgrade an instance of Fonto Editor:

    fdt editor upgrade [--version <version|'nightly'>] [--non-interactive]

Add add-ons to, or remove add-ons from, a Fonto Editor instance:

    fdt editor add-ons [--add <addonName> [<addonName> ...]] [--remove <addonName> [<addonName> ...]] [--add-ons <addonName> [<addonName> ...]] [--non-interactive]

Start a development server for running a Fonto Editor instance:

    fdt editor run [--body-parser-limit <limit>] [--cache-control-disabled] [--cache-control-max-age <maxAge>] [--delay <delay>] [--disable-dist-authentication] [--dist] [--lock-not-acquired] [--lock-not-available] [--memory-store-ttl <seconds>] [--open] [--port] [--release-locks-on-state-request] [--savemode <savemode>] [--verbose]

Create a build version of a Fonto Editor instance for production usage:

    fdt editor build [--no-mangle]

Compile a XSD schema to a schema format which can be used by Fonto Editor:

    fdt editor schema compile [<input>] [--overwrite] [--version <version|'nightly'>]

### Connectors

Initialize a Fonto Connectors instance in an empty or non-existent directory:

    fdt connectors init [--location <path>] --version <version>

Run a Fonto Connectors instance with a self-signed certificate to test your configuration:

    fdt connectors run [--location <path>] [--config-location <path>]

Build a Fonto Connectors docker image for production use:

    fdt connectors build [--location <path>] [--image-name <image-name>] [--image-tag <image-tag>]

Upgrade an existing Fonto Connectors instance to the specified version:

    fdt connectors upgrade [--location <path>] --version <version>

Download a self-contained build:

    fdt connectors download-self-contained --version <version> --runtime <runtime> [--location <path>]

### Content Quality

Initialize a Fonto Content Quality instance in an empty or non-existent directory:

    fdt content-quality init [--location <path>] --version <version>

Run a Fonto Content Quality instance to test your configuration:

    fdt content-quality run [--location <path>] [--config-location <path>] [--port]

Build a Fonto Content Quality docker image for production use:

    fdt content-quality build [--location <path>] [--image-name <image-name>] [--image-tag <tag>]

Upgrade an existing Fonto Content Quality instance to the specified version:

    fdt content-quality upgrade [--location <path>] --version <version>

Download a self-contained build:

    fdt content-quality download-self-contained --version <version> --runtime <runtime> [--location <path>]

### Document History

Download a self-contained build:

    fdt document-history download-self-contained --version <version> --runtime <runtime> [--location <path>]

### Review

Download a self-contained build:

    fdt review download-self-contained --version <version> --runtime <runtime> [--location <path>]

### Schema Compiler

Download a self-contained build:

    fdt schema-compiler download-self-contained --version <version> --runtime <runtime> [--location <path>]

### Spell Checker

Download a self-contained build:

    fdt spell-checker download-self-contained --version <version> --runtime <runtime> [--location <path>]