Invenzzia »

New Command-Line Interface for TF 0.1.2

From Invenzzia wiki

Jump to: navigation, search

This page describes an experimental feature.


The revision 33 for 0.1 branch comes with a new command-line interface for TypeFriendly with some new features. The usage of the new CLI is a bit different than in the previous versions and this document describes it briefly.

New argument style

TypeFriendly 0.1.2 will use the new argument style:

php typefriendly.php ACTION [DOC_PATH] [OPTIONS]

The most important part is ACTION that specifies what TypeFriendly should do. Moreover, the documentation path is not used by all the available actions.

Currently supported actions

  1. create - Allows to create a new documentation from a template. TypeFriendly asks you four questions about the documentation title etc. and then generates the necessary files and directories for you.
  2. build - The current default mode. TypeFriendly generates the output documents from the source form.
  3. compare - compares the files between different language versions. The equivalent of the -c option from TF 0.1.0 and 0.1.1.
  4. version - shows version information.
Personal tools