TYPO3 v15 dev-main snapshot ()
This commit is contained in:
@@ -0,0 +1,119 @@
|
||||
:navigation-title: Console tools
|
||||
|
||||
.. include:: /Includes.rst.txt
|
||||
.. _console-tools:
|
||||
|
||||
=======================================
|
||||
Console tools to manage scheduler tasks
|
||||
=======================================
|
||||
|
||||
Console commands to manage scheduler tasks include :command:`typo3 scheduler:list`,
|
||||
:command:`typo3 scheduler:execute` and :command:`typo3 scheduler:run`.
|
||||
|
||||
You can display detailed help on these commands, by using the `--help` parameter to
|
||||
display the help:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer mode
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
vendor/bin/typo3 scheduler:list --help
|
||||
|
||||
.. group-tab:: Classic mode
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
typo3/sysext/core/bin/typo3 scheduler:list --help
|
||||
|
||||
See also: `Command usage in terminal environments <https://docs.typo3.org/permalink/t3coreapi:how-to-run-a-command>`_.
|
||||
|
||||
.. contents:: Table of contents
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:caption: Subpages
|
||||
:titlesonly:
|
||||
|
||||
*
|
||||
|
||||
.. _console-run:
|
||||
|
||||
Running the scheduler
|
||||
=====================
|
||||
|
||||
The command :command:`typo3 scheduler:run` is usually called by the
|
||||
`cron job <https://docs.typo3.org/permalink/typo3/cms-scheduler:cron-job>`_.
|
||||
|
||||
It looks for tasks that are **due**, and runs them. You can
|
||||
optionally target specific task IDs, force them even if not due, or stop them.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer mode
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
vendor/bin/typo3 scheduler:run
|
||||
|
||||
.. group-tab:: Classic mode
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
typo3/sysext/core/bin/typo3 scheduler:run
|
||||
|
||||
.. seealso::
|
||||
`Running the scheduler: typo3 scheduler:run <https://docs.typo3.org/permalink/typo3/cms-scheduler:scheduler-shell-script>`_
|
||||
|
||||
.. _console-execute:
|
||||
|
||||
Executing scheduler tasks
|
||||
=========================
|
||||
|
||||
The command :command:`typo3 scheduler:execute` is a "manual fire" runner. You pick
|
||||
tasks (IDs or whole groups) and it **executes them on demand**, regardless of
|
||||
whether they are due. It can also prompt you interactively to choose.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer mode
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Note the id of the task
|
||||
vendor/bin/typo3 scheduler:list
|
||||
|
||||
vendor/bin/typo3 scheduler:execute --task=<taskUid>
|
||||
|
||||
.. group-tab:: Classic mode
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Find the id of the task
|
||||
typo3/sysext/core/bin/typo3 scheduler:list
|
||||
|
||||
typo3/sysext/core/bin/typo3 scheduler:execute --task=<taskUid>
|
||||
|
||||
.. _console-list:
|
||||
|
||||
Listing all scheduler tasks
|
||||
===========================
|
||||
|
||||
Command :command:`typo3 scheduler:list` can be used to list all available tasks.
|
||||
This command basically displays the same information as the backend module
|
||||
:guilabel:`Administration > Scheduler`.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer mode
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
vendor/bin/typo3 scheduler:list
|
||||
|
||||
.. group-tab:: Classic mode
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
typo3/sysext/core/bin/typo3 scheduler:list
|
||||
@@ -0,0 +1,141 @@
|
||||
:navigation-title: Run the scheduler
|
||||
|
||||
.. include:: /Includes.rst.txt
|
||||
.. _scheduler-shell-script:
|
||||
|
||||
==========================================
|
||||
Running the scheduler: typo3 scheduler:run
|
||||
==========================================
|
||||
|
||||
The scheduler provides a PHP shell script designed to be run using
|
||||
TYPO3's command-line dispatcher. To try and run that script a first
|
||||
time, type the following command.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer-based installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
vendor/bin/typo3 scheduler:run
|
||||
|
||||
.. group-tab:: Classic installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
typo3/sysext/core/bin/typo3 scheduler:run
|
||||
|
||||
See also `TYPO3 Explained: Run a command from the command
|
||||
line <https://docs.typo3.org/permalink/t3coreapi:symfony-console-commands-cli>`_.
|
||||
|
||||
.. contents:: Table of contents
|
||||
|
||||
.. _scheduler-shell-script-help:
|
||||
|
||||
Show help
|
||||
=========
|
||||
|
||||
In order to show help:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer-based installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
vendor/bin/typo3 scheduler:run --help
|
||||
|
||||
.. group-tab:: Classic installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
typo3/sysext/core/bin/typo3 scheduler:run --help
|
||||
|
||||
.. _scheduler-shell-script-options:
|
||||
|
||||
Providing options to the shell script
|
||||
=====================================
|
||||
|
||||
The shell scripts accepts a number of options which can be provided in any
|
||||
order.
|
||||
|
||||
.. _scheduler-shell-script-options-i:
|
||||
|
||||
`--task (-i)`
|
||||
-------------
|
||||
|
||||
To run a specific scheduler task you need to provide the uid of the task:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer-based installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Run task with uid 42
|
||||
vendor/bin/typo3 scheduler:run --task=42
|
||||
|
||||
# Run tasks with uid 3 and 14
|
||||
vendor/bin/typo3 scheduler:run --task=3 --task=14
|
||||
|
||||
.. group-tab:: Classic installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Run task with uid 42
|
||||
typo3/sysext/core/bin/typo3 scheduler:run --task=42
|
||||
|
||||
# Run tasks with uid 3 and 14
|
||||
typo3/sysext/core/bin/typo3 scheduler:run --task=3 --task=14
|
||||
|
||||
The tasks will be executed in the order in which the parameters are provided.
|
||||
|
||||
.. _scheduler-shell-script-options-f:
|
||||
|
||||
`--force (-f)`
|
||||
--------------
|
||||
|
||||
To run a task even if it is disabled (or not scheduled to be run yet),
|
||||
you need to provide the force option:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer-based installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Run task with uid 42, even if disabled
|
||||
vendor/bin/typo3 scheduler:run --task=42 --force
|
||||
|
||||
.. group-tab:: Classic installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Run task with uid 42, even if disabled
|
||||
typo3/sysext/core/bin/typo3 scheduler:run --task=42 --force
|
||||
|
||||
This will also run the task with uid 42 if it is disabled.
|
||||
|
||||
.. _scheduler-shell-script-options-v:
|
||||
|
||||
`--verbose (-v)`
|
||||
----------------
|
||||
|
||||
A single `-v` flag will output errors only. Two `-vv` flags will also output
|
||||
additional information:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Composer-based installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Run task with uid 42, with detailed stack traces
|
||||
vendor/bin/typo3 scheduler:run --task=42 -vv
|
||||
|
||||
.. group-tab:: Classic installation
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Run task with uid 42, with detailed stack traces
|
||||
typo3/sysext/core/bin/typo3 scheduler:run --task=42 -vv
|
||||
Reference in New Issue
Block a user