0 votes

Paratext Lite's Cmd line arguments.

  • This does not apply to Android. (Desktop only)
  • This is intended for advanced admin use of Paratext Lite only.
  • Could be used as part of automation scripts.


Paratext Lite has an extensive set of command line arguments. 

Initially Paratext Lite options mirrored Paratext's command line arguments. (eg. --rdwrtp8 - which existed for syncing with AdaptIt), but over time more options were added, initially so admins could fix problems and automate things. Then functionality useful for internal development work was added. 


Here is an overview of some of the capabilities, in case it is useful to anyone. (more information can be found by supplying the --help flag to paratextlite command line):


Non Project Data
  reset                         Revert to default settings. On Linux, also closes any running Paratext Lite instances.
  layout                       Named workspace layouts: export, import, snapshot live workspace, activate or delete a layout, list names.
  regcode                    Read/Update/Verify current reg code.


Projects and resources management
  listprojects                  List available projects (local or on S/R server)
  sendreceive                Send receive project and exit.
  sendreceiveserver      Get or set which Send/Receive server is used (Production or Development).
  resources                    List and install DBL/Marble resources.
  shareresources           Allow other devices to install resources using this machine as a source.
  deleteproject               Delete specified Paratext projects from this device. Warning any changes not send/received will be lost.


  Searching and modifying project data.
  export, read, save            Save paratext project content to file.
  import, update, write        Update a paratext project with the contents of specified file.
  projectinfo                        Output metadata for specified projects
  grep, search                     Search through USFM content with regex
  changes, log                     List Hg changes (rev, date, author)
  diff                                    Show USFM changes since a specified revision
  listusers                            List project users
  notes                                List or filter project notes, and show a single note by ID.
  checks                              Run Paratext scripture basic checks (ChapterVerse, Capitalization, Marker, etc.) for a project.
  biblicalterms                     Lookup biblical terms and vernacular renderings for projects.
  wordlist                             List words used in specified projects with optional spelling and scope filters.
  markpointinhistory            Commit project changes (mark point in history).


If there is anything obvious missing from the set of command line options that would be useful, please let us know.


The Linux version of Paratext Lite can be installed via a snap package. https://snapcraft.io/paratextlite
(Command line options also works on non Linux Desktop platforms like macos )

Paratext Lite ago by [Moderator]
(2.4k points)

Please log in or register to answer this question.

Welcome to Support Bible, where you can ask questions and receive answers from other members of the community.
But if we walk in the light, as he is in the light, we have fellowship with one another, and the blood of Jesus, his Son, purifies us from all sin.
1 John 1:7
3,036 questions
5,990 answers
5,659 comments
2,020 users