TruxtonCLI.exe

Also known as the Truxton Command Line interface. TruxtonCLI.exe is located in C:\Program Files\Truxton\Tools\TruxtonCli.exe. TruxtonCLI.exe offers many ways of performing tasks related to a Truxton instance from the command line. Each command from TruxtonCLI.exe can provide additional information about itself with the --help option.

TruxtonCLI:
  Manage all things Truxton

Usage:
  TruxtonCLI [options] [command]

Options:
  --version         Show version information
  -?, -h, --help    Show help and usage information

Commands:
  investigation    View and manage investigations in Truxton
  license          View and manage the license for Truxton
  loadconfig       View and manage load configs
  media            View and manage media in Truxton
  messagebus       View message bus for Truxton
  route            View and manage routes
  stage            View and manage stages
  depot            Manage depots

Commands

investigation

  View and manage investigations in Truxton

Usage:
  TruxtonCLI investigation [options] [command]

Options:
  -?, -h, --help    Show help and usage information

Commands:
  report         Generates a named report
  list           Lists all investigation
  get            Gets a specific investigation by id
  export         Exports an investigation to tpif (truxton portable investigation format)
  publish        Publishes an investigation to another instance of Truxton. This operation will not proceed if there
                 are any media in the investigation which have not completed loading, unless the --force switch is
                 specified.
  import         Imports a tpif (truxton portable investigation format)
  create         Create an investigation
  delete         Delete an investigation
  associate      Associates an investigation and a media
  unassociate    Unassociates an investigation and a media

Sample

Export an Investigation

The following will save only the meta data from an investigation.

"C:\Program Files\Truxton\Tools\TruxtonCLI.exe" investigation export --id 01d7c1d3-22e3-dcb7-0000-015e3c18aa65 --file "E:\Investigation.tpif"

The following will save the meta data and file contents of an investigation. This will make a significantly larger TPIF file.

"C:\Program Files\Truxton\Tools\TruxtonCLI.exe" investigation export --id 01d7c1d3-22e3-dcb7-0000-015e3c18aa65 --file "E:\Investigation.tpif" --content true

Import an Investigation

"C:\Program Files\Truxton\Tools\TruxtonCLI.exe" investigation import --file "E:\Investigation.tpif"

Write GeoJSON Report

This will generate a GeoJSON report containing all of the locations in an investigation.

"C:\Program Files\Truxton\Tools\TruxtonCLI.exe" investigation report --id 9e47c882-2a01-4030-9d2e-32cf566efbf4 --file "C:\temp\i.geojson" --name geojson

Delete an Investigation

This will delete the investigation but none of the media in the investigation.

"C:\Program Files\Truxton\Tools\TruxtonCLI.exe" investigation delete --force --id 20220405-1111-1111-2222-000000000001

license

  View and manage the license for Truxton

Usage:
  TruxtonCLI license [options] [command]

Options:
  -?, -h, --help    Show help and usage information

Commands:
  register      Register a new license
  deregister    Removes the existing license
  view          View the current license information

loadconfig

  View and manage load configs

Usage:
  TruxtonCLI loadconfig [options] [command]

Options:
  -?, -h, --help    Show help and usage information

Commands:
  list      Lists all load configurations
  add       Add a new load config
  remove    Removes an existing load config

media

  View and manage media in Truxton

Usage:
  TruxtonCLI media [options] [command]

Options:
  -?, -h, --help    Show help and usage information

Commands:
  list       Lists all media
  get        Gets a specific media by id
  export     Exports a media to tpmf (truxton portable media format)
  publish    Publishes a media to another instance of Truxton. This operation will not proceed if the media has not
             completed loading, unless the --force switch is specified.
  import     Imports a tpmf (truxton portable media format)
  delete     Delete a media
  purge      Purges expired media

Sample

Delete a Piece of Media

This will delete a piece of media from Truxton. It does this by sending a message to the maintenance queue which will do the actual deletion.

"C:\Program Files\Truxton\Tools\TruxtonCLI.exe" media delete --force --id 20220405-1111-1111-2222-000000000001

messagebus

  View message bus for Truxton

Usage:
  TruxtonCLI messagebus [options] [command]

Options:
  -?, -h, --help    Show help and usage information

Commands:
  status    Lists the status of the message bus

route

  View and manage routes

Usage:
  TruxtonCLI route [options] [command]

Options:
  -?, -h, --help    Show help and usage information

Commands:
  list      Lists routes by load configuration id
  add       Add a new route
  remove    Removes an existing route

stage

  View and manage stages

Usage:
  TruxtonCLI stage [options] [command]

Options:
  -?, -h, --help    Show help and usage information

Commands:
  list      Lists all stages
  add       Add a new stage
  remove    Removes an existing stage

depot

  Manage depots

Usage:
  TruxtonCLI depot [options] [command]

Options:
  -?, -h, --help    Show help and usage information

Commands:
  migrate    Migrates Depots from the current datadir to another. The current datadir is typically located in the
             TruxtonSettings.xml configuration file. If Truxton services are running it will turn off those services
             and turn them back on when completed.