Command Line

AVAA Toolkit was made for the command line and can integrate seamlessly in any tool chain.

Usage: avaa-toolkit [options] XML files or folders to process
  Options:
    --lang
      Language of the generated document, if translations are available
      Default: <empty string>
    --watch
      Watch for xml changes and regenerate documents
      Default: false
    --combine
      Combine documents into one final html file
      Default: false
    --pdf
      Also convert HTML to PDF
      Default: false
    --zip-all
      Zip all generated documents together
      Default: false
    --zip-each
      Zip each generated documents separately
      Default: false
    --deployer-user
      Deployer user name
      Default: <empty string>
    --deployer-pass
      Deployer password
      Default: <empty string>
    --deploy
      Upload zip to deployer
      Default: false
    --deployer-url
      Specify a custom deployer URL to upload zip to
      Default: <empty string>
    --debug
      Debug mode
      Default: false
    --verbose
      Display more information when converting
      Default: true
    --path-temp
      Temporary files directory. Default to ./temp/
    --path
      Root of application. Default to executing .jar directory
    --test-or-die
      Run all tests and exit with error code on any failed test
      Default: false
    --test
      Run a XML document as a test suite
    --gendoc
      Generate all documentation and exit
      Default: false
    --test-all
      Run all tests
      Default: false
    --dev
      Reload scripts before converting a document
      Default: false
    --cache-af
      Cache annotations file in memory for faster exec
      Default: true
    --server-allowed-origin
      A custom origin URL allowed to connect to the server
      Default: <empty string>
    --server
      Websocket server for editor and interactive sessions
      Default: false
    --server-port
      Websocket server port
      Default: 41744
    --server-ssl
      Use SSL certificate (for Server Mode)
      Default: false
    --mongo-host
      Address of the mongodb server
      Default: <empty string>
    --mongo-port
      Port of the mongodb server
      Default: 27017
    --mongo-db
      Name of database to work with
      Default: <empty string>
    --download-remote-corpus
      Whether to automatically download a referenced remote corpus
      Default: true
    --conf
      Custom config file to load
      Default: avaa-config.xml