Login

Learning&Support

Documentation

Twixl Publisher Command Line Interface

Twixl Support Team Updated: - Created :

This article assumes you have a knowledge of using the OS X command line in the Terminal app.

twixl-publisher-cli is a command line tool that can be used to automate certain Twixl Publisher tasks, such as automatic installation of a Twixl Publisher license across a network, or creating app builds:

  • Install a license
  • Preview in the simulator
  • Build
  • Package
  • Export support logs
  • List devices
  • Miscellaneous

Automating tasks

To get started, enter the following command in Terminal:

/Applications/Twixl\ Publisher.app/Contents/Resources/twixl-publisher-cli --help

The help window will list all the options, each with one or more parameters.

Terminal

1. License

--install-license <value>
Installs and validates a license key
--uninstall-license
Uninstalls the license key
--show-license
Show the current license key information

2. Plugin

--install-plugin
Installs the Adobe InDesign plugins
--uninstall-plugin
Uninstalls the Adobe InDesign plugins

3. Helper

--install-helper
Installs the Twixl Publisher Helper
--uninstall-helper
Uninstalls the Twixl Publisher Helper

4. Preview

--preview
Preview the publication using the iOS Simulator
--publication <value>
The path to the publication to preview
--preview-device-type [<value>]
The device type to perform the preview on

5. Build

--build
Convert a publication into an iPad or an Android application.
--publication [<value>]
The path to the publication to build.
--output-folder <value>
The path where the builds should be stored.
--settings <value>
The build settings to use.
--app-version <value>
The application version to embed in the build.
--build-ios <value>
Creates an iOS version of the app (ios-development, ios-adhoc, ios-appstore, ios-enterprise).
--android-test
Creates an Android test version of the app.
--android-google-play
Creates an Google Play version of the app.
--web-reader
Creates a web reader version of the publication.
--ota-install-files
Creates the iOS over-the-air install files.

6. Export support log files

--export-logs
Export the support logfiles
--output-file <value>
The zip file in which to export the support logfiles

7. Miscellaneous

--output-text
Output plain text instead of JSON
--version
Display version and exit
--help
Display this help and exit

8. Automated Twixl Publisher plug-in installation on OS X

If you want to deploy the Twixl Publisher plug-in for multiple OS X users, there is a way to do this, however, the location of the plugin depends on the version of InDesign you are using. Here's an overview of the different paths:

  • Twixl Publisher App: /Applications/Twixl Publisher.app
  • Helper app: /Library/LaunchDaemons/com.twixlmedia.publisher.helper.plist
  • Helper app: /Library/Application Support/Twixl Publisher/Queue
  • Plugin CS5: /Library/Application Support/Adobe/CS5ServiceManager/Extensions
  • Plugin CS5.5: /Library/Application Support/Adobe/CS5.5ServiceManager/Extensions
  • Plugin CS6: /Library/Application Support/Adobe/CS6ServiceManager/Extensions
  • Plugin CC: /Library/Application Support/Adobe/CEPServiceManager4/Extensions
  • Plugin CC 2014/2015/2018: /Library/Application Support/Adobe/CEP/Extensions
  • Build Settings + Android SDK: ~/Library/Application Support/Twixl Publisher
  • Preferences: ~/Library/Preferences/com.twixlmedia.publisher.mac.plist

If you have the Twixl Publisher OS X app installed on the system, there is a tool you can use to install the plugin automatically:

sudo python /Applications/Twixl Publisher.app/Contents/Resources/install_plugin.sh

You will need to run it as root as it automatically installs the helper daemon as well.

Was this article helpful?

0 out of 0 found this helpful