mindtouch.import

Requirements

MindTouch 9.08 or later

.NET 3.5/Mono 2.4 or later

Modes

The tool can perform one of three actions: export, import, or copy.

Note: If the genconfig option is specified, the provided arguments are used to generate an xml configuration file that can be used to excecute the specified command using the config option. Regardless of whether the documents to export is specified by the exportpath option, an external exportlist or exportdoc, the generated configuration file will have embedded the loaded or created export document inside the config file.

mindtouch.import -e -h mywiki.com -r mywiki.zip

# here's a path
/foo/baz

# here's a URIs
http://mywiki.com/foo/bar

# index.php style Uri's are also valid
http://mywiki.com/index.php?title=foo/%26_some_strange_name

mindtouch.import -h mywiki.com -I /backup mywiki.zip

mindtouch.import -h mywiki.com -I /backup http://mindtouch.com/packages/mypackage.zip

mindtouch.import -c -h mywiki.com -X /staging -I /production -r

Using a configuration file

All options can be specified either on the command line or in an xml configuration file. Both methods can be used together, i.e. the configuration file could contain the authentication information, so that it isn't part of the command line, while the remaining options are specified on the command line.

The format of the configuration file uses attributes for each commandline option. Any option-attributed omitted is treated just like an omitted command line option. In addition the exportdoc option can be omitted and the export document inlined directly:

<config export='(true|false)'
        copy='(true|false)'
        config='{path}'
        host='{host}'
        uri='{uri}'
        archive='(true|false)'
        importreltopath='{path}'
        importrelto='{id}'
        exportreltopath='{path}'
        exportrelto='{id}'
        exportdoc='{path}'
        exportpath='{path}'
        recursive='(true|false)'
        authtoken='{token}'
        user='{username}'
        password='{password}' >
  
  <!-- the archive/directory target. For export or copy operations only -->
  <target>{path}</target>
  
  <!--optionally inlined export document-->
  <export>
    ...
  </export>
</config>

Complete list of command line options

Running the tool without any command line options prints the usage instructions.

USAGE: mindtouch.import.exe [options] [target]

  [target] is either a path to a directory or a filepath ending in .mtarc or .mtapp
     (not used for copy operations)

Options:
    (Options must be prefixed by a '-' or '/')

    Modes: Import (default), Export or Copy
      e|export                 - export mode
      c|copy                   - copy mode

    General:
      ?|usage                  - display this message
      C|config <path>          - confguration xml file (see below)
      g|genconfig <path>       - instead of executing the command, generate the config file for later execution
      h|host <host>            - MindTouch host (assumes standard API location)
      u|uri <api-uri>          - specify the full uri to the API
      a|archive                - force the target to be treated as an archive file
      f|folder                 - force the target to be treated as a folder
      I|importreltopath <path> - relative uri path for import and copy destination
      importrelto <id>         - relative page id for import and copy destination (alternative to importreltopath)
      X|exportreltopath <path> - relative uri path for export and copy source
      exportrelto <id>         - relative page id for export and copy source (alternative to exportreltopath)
      D|exportdoc  <filename>  - filename of the export xml document for export or copy
      L|exportlist <filename>  - list of paths or uri's to pages to export (respects 'recursive' flag)
      p|exportpath <path>      - specifies the uri path to export (in lieu of specifying an export document/list)
      r|recursive              - export all child documents of 'exportpath' or 'exportlist'
      o|output                 - output file/directory path for import or export
      R|retries                - Maximum number of retries on import/export item failures (default: 3)
      l|preservelocal          - mark package to preserve local changes to existing pages on import
      O|overwritelocal         - mark package to preserve local changes to existing pages on import
                                 (overwrite is the default unless the package has a different value set, in which case
                                  this flag can be used to forces overwrite behavior on import)
      s|securityrestriction (public|semipublic|private)
                               - enforce a page restriction for all imported content
      cap <capability-name>[=<capability-value>]
                               - add a capability requirement for the exported package. The default for capability-value
                                 'enabled'

    Authentication:
      (if no authentication is provided, the program will prompt for user and password interactively)
      A|authtoken <token>      - authtoken to use for user authentication
      U|user <username>        - username for authentication (requires password option
      P|password <password>    - password for username authentcation

Xml Configuration:
    Commandline options can be provided by or augmented with an xml configuration document:
      <config [option-longname]='value' ...>
        [ <target>{output/input file/dir for import/export}</target> ]
        [ <export><!--optionally inlined export document--></export> ]
      </config>
    Value-less options are booleans and have an xml attribute value of 'true' or 'false'.
    The 'genconfig' option creates this configuration document from the provided settings for later use.