Overview of CLI commands

Since versions 12.19.0 / 13.13.0 / 14.1.0, the AI Suite provides console commands that allow integrators to automate AI Suite operations, such as metadata generation and translations, via the command line or the TYPO3 scheduler. Additionally, there is the backend module "AI Suite CLI" under Tools as a status overview. The prerequisite for execution is the permission "Enable CLI workflow execution" (enable_cli_workflow_execution).

Executes an AI Suite workflow (metadata generation or translation) and creates tasks for later CLI processing. Main options:

• --type, -t: Workflow type page, pageTranslate, fileReferences, fileMetadata, fileMetadataTranslation
• --model, -m: AI model to use
• --start-from-pid: Start page ID (for page-based types)
• --page-type, --depth, --column: Page type filter, traversal depth, column to process. For file based types, --depth has, since versions 14.4.0/13.16.0/12.22.0, meant the number of sub folder levels below the given directories (0 = only these directories, maximum 5)
• --sys-language: System language (locale ID)
• --source-language, --target-language, --translation-scope (all | metadata | content): for translation workflows
• --directory: Directories to process, e.g. /, /user_upload/ or 1:/user_upload/. Since versions 14.4.0/13.16.0/12.22.0, several directories are possible, separated by commas, e.g. /user_upload/,1:/images/
• --show-only-empty, --show-only-used: consider only empty fields or only used files
• --prompt: own prompt for metadata generation, replaces the predefined instruction of the selected field (since versions 14.4.0/13.16.0/12.22.0)

Queries the AI server for the status of the CLI-processed background tasks and stores completed results. This command is the ideal candidate for a recurring scheduler task that automatically processes the tasks created by execute-workflow.

Retries failed CLI background tasks, currently limited to the status task-error.

• --type, -t: Filter by task type (same types as in execute-workflow)
• --model, -m: overrides the AI model used (if not specified, the original model of the task is used)

The module is located in the Tools area. It displays pending and failed CLI tasks, grouped by scope, including statistics and type filters. Additionally, it shows whether the TYPO3 scheduler is available and whether the command ai-suite:process-tasks has already been set up as a scheduler task.

The typical process: execute-workflow generates the tasks, process-tasks (ideally via scheduler) processes them, the CLI module monitors the status, and retry-tasks resets failed tasks.

Relevant settings in the Global Settings: maxTasks (maximum number of concurrently processed background tasks) as well as the GDPR mode. For background processing, the permission "Enable background task handling" is also required.

Typical calls, each can be copied by clicking. Replace [model] with the identifier of the desired AI model.