Send/Receive via command line

Question

Is there a way to update project data without turning on Paratext and doing it with human intervention? I faintly remember there being an API which allowed this, but I can't find information about it.

Background: I'm helping a project which would like to create a continuous integration system to automatically check for updates to the PT data, and build new versions of apps and webpages and print documents when such updates are found.

Answer 1

Paratext Lite has a set of command line arguments, one of which allows automated Send/Receives.

paratextlite --help

Usage:
  ParatextLite [command] [options]

Options:
  --projectsPath <projectsPath>    specify paratext projects path.
  -d, --debug                      debugging: enable logging to terminal + dev tools.
  --addTimings                     debugging: if debugging enabled, add api timings to output.
  --disableHost                    debugging: Start backend and wait. (listens at http://localhost:8888/)
  --useBundle <useBundle>          debugging: specify bundle.js
  --websocketPort <websocketPort>  Override websocket port used internally. Default : 9999
  --webserverPort <webserverPort>  Override webserver port used internally. Default : 8888
  --disableErrorReports            Disable automatic error reports
  --rdwrtp8                        (obsolete) 'rdwrtp8 -r|-w project book chapter|0 fileName (-x)'
                                    -x : use usx.
                                    -r : save from paratext to specified fileName
                                    -w : update paratext with content from specified fileName
  --version                        Show version information
  -?, -h, --help                   Show help and usage information

Commands:
  reset                  revert to default settings.
  sendreceive            send receive project and exit.
  export, read, save     Save paratext project content to file.
  import, update, write  Update a paratext project with the contents of specified file.
  exportlayout           Save a named layout to file.
  importlayout           Add or Update a named layout from file.
  regcode                Read/Update current reg code.
  listprojects           list avaliable projects

paratextlite sendreceive --help

Description:
  send receive project and exit.

Usage:
  ParatextLite sendreceive [options]

Options:
  -p, --projects <projects> (REQUIRED)  projects to use. Specify one or more. []
  --projectsPath <projectsPath>         specify paratext projects path.
  --allProjects                         Use all valid registered projects that the registered user can S/R. If specified, --projects
                                        is ignored. [default: False]
  -?, -h, --help                        Show help and usage information

Comments

Thank you very much! I've just tested it, and so far this looks like exactly what I was looking for... even easier than I expected.