23.8. Utilisation du traitement à partir de la ligne de commande

QGIS comes with a tool called QGIS Processing Executor which allows you to run Processing algorithms and models (built-in or provided by plugins) directly from the command line without starting QGIS Desktop itself.

From a command line tool, run qgis_process and you should get:

QGIS Processing Executor - 3.16.8-Hannover 'Hannover' (3.16.8-Hannover)
Usage: C:\OSGeo4W\apps\qgis-ltr\bin\qgis_process.exe [--json] [command] [algorithm id or path to model file] [parameters]

Options:

  --json          Output results as JSON objects

Available commands:

  plugins          list available and active plugins
  plugins enable   enables an installed plugin. The plugin name must be specified, e.g. "plugins enable cartography_tools"
  plugins disable  disables an installed plugin. The plugin name must be specified, e.g. "plugins disable cartography_tools"
  list             list all available processing algorithms
  help             show help for an algorithm. The algorithm id or a path to a model file must be specified.
  run              runs an algorithm. The algorithm id or a path to a model file and parameter values must be specified.
                   Parameter values are specified after -- with PARAMETER=VALUE syntax.
                   Ordered list values for a parameter can be created by specifying the parameter multiple times,
                   e.g. --LAYERS=layer1.shp --LAYERS=layer2.shp
                   If required, the ellipsoid to use for distance and area calculations can be specified via the "--ELLIPSOID=name" argument.
                   If required, an existing QGIS project to use during the algorithm execution can be specified via the "--PROJECT_PATH=path" argument.

Note

Only installed plugins that advertize hasProcessingProvider=yes in their metadata.txt file are recognized and can be activated or loaded by qgis_process tool.

La commande list peut être utilisée pour obtenir une liste de tous les fournisseurs et algorithmes disponibles.

qgis_process list

La commande help peut être utilisée pour obtenir des informations supplémentaires sur les commandes ou les algorithmes.

qgis_process help qgis:regularpoints

La commande run peut être utilisée pour exécuter un algorithme ou un modèle. Spécifiez le nom de l’algorithme ou un chemin d’accès à un modèle comme premier paramètre.

qgis_process run qgis:buffer -- INPUT=source.shp DISTANCE=2 OUTPUT=buffered.shp

Lorsque le paramètre requiert plusieurs valeurs, il faut définir la variable autant de fois que nécessaire.

qgis_process run native:mergevectorlayers -- LAYERS=input1.shp LAYERS=input2.shp OUTPUT=merged.shp

While running an algorithm a text-based feedback bar is shown, and the operation can be cancelled via CTRL+C. The run command also supports further parameters.

  • --json formattera la sortie stdout selon une structure de type JSON.

  • --ellipsoid fixera l’ellipsoïde à celui qui est spécifié.

  • --distance_units utilisera les unités de distance spécifiées

  • --area_units utilisera les unités de surface spécifiées.

  • --project_path chargera le projet spécifié pour l’exécution de l’algorithme.