Command Line Interface (CLI) commands

Reading time: 2 minutes


Sometimes you may need to use the command line with Mautic. Here follows a list of the CLI commands that can be used.

You can find this list (and others - for example commands relating to Doctrine and other vendors) by typing

app/console

at the command line in your Mautic directory.

Usage: command [options] [arguments]

Options:

OptionDescription
-h, --helpDisplay this help message
-q, --quietDo not output any message
-V, --version
      --ansi
      --no-ansi
Display this application version
Force ANSI output
Disable ANSI output
-n, --no-interactionDo not ask any interactive question
-s, --shell
      --process-isolation
Launch the shell.
      Launch commands from shell as a separate process.
-e, --env=ENV
      --no-debug
The Environment name. [default: "prod"]
      Switches off debug mode.
-v
-vv
-vvv
       --verbose
Increase the verbosity of messages:
1 for normal output,
2 for more verbose output and
3 for debug

Mautic commands

These are the commands you may need to use in relation to your Mautic instance. They should be preceded by app/console.

CommandDescription
mautic:assets:generateCombines and minifies asset files from each bundle into single production files
mautic:broadcasts:sendProcess contacts pending to receive a channel broadcast.
mautic:campaigns:executeExecute specific scheduled events.
mautic:campaigns:messagequeueProcess sending of messages queue.
mautic:campaigns:messagesProcess sending of messages queue.
mautic:campaigns:rebuildRebuild campaigns based on contact segments.
mautic:campaigns:triggerTrigger timed events for published campaigns.
mautic:campaigns:updateRebuild campaigns based on contact segments.
mautic:campaigns:validateValidate if a contact has been inactive for a decision and execute events if so.
mautic:citrix:syncSynchronizes registrant information from Citrix products
mautic:contacts:deduplicateMerge contacts based on same unique identifiers
mautic:email:fetchFetch and process monitored email.
mautic:emails:sendProcesses SwiftMail's mail queue
mautic:importImports data to Mautic
mautic:install:dataInstalls Mautic with sample data
mautic:integration:fetchleadsFetch leads from integration.
mautic:integration:pipedrive:fetchPulls the data from Pipedrive and sends it to Mautic
mautic:integration:pipedrive:pushPushes the data from Mautic to Pipedrive
mautic:integration:pushactivityPush lead activity to integration.
mautic:integration:pushleadactivityPush lead activity to integration.
mautic:integration:synccontactsFetch leads from integration.
mautic:iplookup:downloadFetch remote datastores for IP lookup services that leverage local lookups
mautic:maintenance:cleanupUpdates the Mautic application
mautic:messages:sendProcess sending of messages queue.
mautic:migrations:generateGenerate a blank migration class.
mautic:plugins:installInstalls, updates, enable and/or disable plugins.
mautic:plugins:reloadInstalls, updates, enable and/or disable plugins.
mautic:plugins:updateInstalls, updates, enable and/or disable plugins.
mautic:queue:processProcess queues
mautic:reports:schedulerProcesses scheduler for report's export
mautic:segments:check-buildersCompare output of query builders for given segments
mautic:segments:rebuildUpdate contacts in smart segments based on new contact data.
mautic:segments:updateUpdate contacts in smart segments based on new contact data.
mautic:social:monitoringLooks at the records of monitors and iterates through them.
mautic:theme:json-configConverts theme config to JSON from PHP
mautic:unusedip:deleteDeletes IP addresses that are not used in any other database table
mautic:update:applyUpdates the Mautic application
mautic:update:findFetches updates for Mautic
mautic:webhooks:processProcess queued webhook payloads
social:monitor:twitter:hashtagsLooks at our monitoring records and finds hashtags
social:monitor:twitter:mentionsSearches for mentioned tweets

Found errors? Think you can improve this documentation? Prefer code to UI? edit this page on Github