Arguments - Fluid Topics - Latest

Fluid Topics Publisher (ftpub)
Category
Technical Notes
Audience
public
Version
Latest
ftpub publish [path/to/directory/or/file] [ft_portal_URL] [flags]

Aliases:

  • publish
  • collect_and_publish

Flags:

Long option Short option Mandatory? Description Environment variable
--api-key -a Yes (use either --api-key, or --user and --password) API key for the Fluid Topics portal. FTPUB_API_KEY
--user -u Yes (use either --api-key, or --user and --password) Username for the Fluid Topics portal. FTPUB_USER
--password -p Yes (use either --api-key, or --user and --password) Password for the Fluid Topics portal. FTPUB_PASSWD
--source -s Yes The ID of the source in Fluid Topics. FTPUB_SOURCE
--dry-run No Creates a ZIP archive of the content without publishing it to the Fluid Topics portal.
--help -h No Shows the help tool.
--wait -w No Displays a message when the publishing job has finished in Fluid Topics.

Using the --wait flag triggers a call per second to the Get a publish report web service (/api/khub/uploads/{uploadId}/report). This can result in a high number of calls.

Global flags:

Long option Short option Mandatory? Description
--verbosity -v No Determines how much information ftpub shows as the command runs.

Options:

  • CRITICAL
  • ERROR
  • WARNING
  • INFO
  • DEBUG

By default: INFO.

ftpub cannot show the possible information, errors, and warnings which appear in the job report.