diff --git a/Neos.Neos/Documentation/References/CommandReference.rst b/Neos.Neos/Documentation/References/CommandReference.rst index 463b5db14b5..949fe3fcb78 100644 --- a/Neos.Neos/Documentation/References/CommandReference.rst +++ b/Neos.Neos/Documentation/References/CommandReference.rst @@ -19,7 +19,7 @@ commands that may be available, use:: ./flow help -The following reference was automatically generated from code on 2017-05-11 +The following reference was automatically generated from code on 2023-10-21 .. _`Neos Command Reference: NEOS.CONTENTREPOSITORY`: @@ -28,58 +28,6 @@ Package *NEOS.CONTENTREPOSITORY* -------------------------------- -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY neos.contentrepository:nodetypes:show`: - -``neos.contentrepository:nodetypes:show`` -************************************** - -**Show NodeType Configuration** - -Shows the merged configuration (including supertypes) of a NodeType - -**Examples:** - -``./flow nodeTypes:show Vendor.Site:Content`` - -``./flow nodeTypes:show Vendor.Site:Content --path="properties.bar"`` - - -Options -^^^^^^^ - -``--node-type-name`` - The name of the NodeType to show -``--path`` - Optional path of the NodeType-configuration which will be shown - - - -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY neos.contentrepository:nodetypes:list`: - -``neos.contentrepository:nodetypes:list`` -************************************** - -**List NodeTypes** - -Lists all declared NodeTypes grouped by namespace - -**Examples:** - -``./flow nodeTypes:list --filter Vendor.Site:`` - -``./flow nodeTypes:list --filter Vendor.Site:Document --include-abstract`` - - - -Options -^^^^^^^ - -``--filter`` - Only NodeType-names containing this string will be listed -``--include-abstract`` - List abstract NodeTypes - - .. _`Neos Command Reference: NEOS.CONTENTREPOSITORY neos.contentrepository:node:repair`: ``neos.contentrepository:node:repair`` @@ -115,14 +63,14 @@ configuration and constraints. *Remove undefined node properties* removeUndefinedProperties -Will remove all undefined properties according to the node type configuration. - *Remove broken object references* removeBrokenEntityReferences Detects and removes references from nodes to entities which don't exist anymore (for example Image nodes referencing ImageVariant objects which are gone for some reason). +Will remove all undefined properties according to the node type configuration. + *Remove nodes with invalid dimensions* removeNodesWithInvalidDimensions @@ -154,6 +102,7 @@ reorderChildNodes For all nodes (or only those which match the --node-type filter specified with this command) which have configured child nodes, those child nodes are reordered according to the position from the parents NodeType configuration. + *Missing default properties* addMissingDefaultValues @@ -171,6 +120,12 @@ It searches for nodes which have a corresponding node in one of the base workspa have different node paths, but don't have a corresponding shadow node with a "movedto" value. +*Create missing sites node* +createMissingSitesNode + +If needed, creates a missing "/sites" node, which is essential for Neos to work +properly. + *Generate missing URI path segments* generateUriPathSegments @@ -185,13 +140,13 @@ Removes content dimensions from the root and sites nodes **Examples:** -``./flow node:repair`` +./flow node:repair -``./flow node:repair --node-type Neos.NodeTypes:Page`` +./flow node:repair --node-type Acme.Com:Page -``./flow node:repair --workspace user-robert --only removeOrphanNodes,removeNodesWithInvalidDimensions`` +./flow node:repair --workspace user-robert --only removeOrphanNodes,removeNodesWithInvalidDimensions -``./flow node:repair --skip removeUndefinedProperties`` +./flow node:repair --skip removeUndefinedProperties @@ -205,39 +160,65 @@ Options ``--dry-run`` Don't do anything, but report actions ``--cleanup`` - If FALSE, cleanup tasks are skipped + If false, cleanup tasks are skipped ``--skip`` Skip the given check or checks (comma separated) ``--only`` Only execute the given check or checks (comma separated) -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY.MIGRATION`: -Package *NEOS.CONTENTREPOSITORY.MIGRATION* -------------------- -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY.MIGRATION neos.contentrepository.migration:node:migrationcreate`: -``neos.contentrepository.migration:node:migrationcreate`` -************************* +.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY neos.contentrepository:nodetypes:list`: + +``neos.contentrepository:nodetypes:list`` +***************************************** + +**Lists all declared NodeTypes grouped by namespace** + + + + + +Options +^^^^^^^ + +``--filter`` + Only NodeType-names containing this string will be listed +``--include-abstract`` + List abstract NodeTypes + + + + + +.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY neos.contentrepository:nodetypes:show`: + +``neos.contentrepository:nodetypes:show`` +***************************************** + +**Shows the merged configuration (including supertypes) of a NodeType** -**Create a node migration for the given package key** -You can specify the ``packageKey`` of your desired package. A node migration will be created in the specified package under ``/Migrations/ContentRepository/``. -The newly created node migration contains a small template to help you to get started, and also a link to the Neos documentation about how node migrations work in Neos. Arguments ^^^^^^^^^ -``--package-key`` - The key for your package (for example ``Neos.Demo``) +``--node-type-name`` + The name of the NodeType to show + -Example + +Options ^^^^^^^ -.. code-block:: bash - ./flow node:migrationcreate --package-key Neos.Demo +``--path`` + Path of the NodeType-configuration which will be shown + + + + .. _`Neos Command Reference: NEOS.FLOW`: @@ -245,6 +226,31 @@ Package *NEOS.FLOW* ------------------- +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:collectgarbage`: + +``neos.flow:cache:collectgarbage`` +********************************** + +**Cache Garbage Collection** + +Runs the Garbage Collection (collectGarbage) method on all registered caches. + +Though the method is defined in the BackendInterface, the implementation +can differ and might not remove any data, depending on possibilities of +the backend. + + + +Options +^^^^^^^ + +``--cache-identifier`` + If set, this command only applies to the given cache + + + + + .. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:flush`: ``neos.flow:cache:flush`` @@ -253,7 +259,8 @@ Package *NEOS.FLOW* **Flush all caches** The flush command flushes all caches (including code caches) which have been -registered with Flow's Cache Manager. It also removes any session data. +registered with Flow's Cache Manager. It will NOT remove any session data, unless +you specifically configure the session caches to not be persistent. If fatal errors caused by a package prevent the compile time bootstrap from running, the removal of any temporary data can be forced by specifying @@ -319,6 +326,122 @@ Related commands +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:list`: + +``neos.flow:cache:list`` +************************ + +**List all configured caches and their status if available** + +This command will exit with a code 1 if at least one cache status contains errors or warnings +This allows the command to be easily integrated in CI setups (the --quiet flag can be used to reduce verbosity) + + + +Options +^^^^^^^ + +``--quiet`` + If set, this command only outputs errors & warnings + + + +Related commands +^^^^^^^^^^^^^^^^ + +``neos.flow:cache:show`` + Display details of a cache including a detailed status if available + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:setup`: + +``neos.flow:cache:setup`` +************************* + +**Setup the given Cache if possible** + +Invokes the setup() method on the configured CacheBackend (if it implements the WithSetupInterface) +which should setup and validate the backend (i.e. create required database tables, directories, ...) + +Arguments +^^^^^^^^^ + +``--cache-identifier`` + + + + + + +Related commands +^^^^^^^^^^^^^^^^ + +``neos.flow:cache:list`` + List all configured caches and their status if available +``neos.flow:cache:setupall`` + Setup all Caches + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:setupall`: + +``neos.flow:cache:setupall`` +**************************** + +**Setup all Caches** + +Invokes the setup() method on all configured CacheBackend that implement the WithSetupInterface interface +which should setup and validate the backend (i.e. create required database tables, directories, ...) + +This command will exit with a code 1 if at least one cache setup failed +This allows the command to be easily integrated in CI setups (the --quiet flag can be used to reduce verbosity) + + + +Options +^^^^^^^ + +``--quiet`` + If set, this command only outputs errors & warnings + + + +Related commands +^^^^^^^^^^^^^^^^ + +``neos.flow:cache:setup`` + Setup the given Cache if possible + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:show`: + +``neos.flow:cache:show`` +************************ + +**Display details of a cache including a detailed status if available** + + + +Arguments +^^^^^^^^^ + +``--cache-identifier`` + identifier of the cache (for example "Flow_Core") + + + + + +Related commands +^^^^^^^^^^^^^^^^ + +``neos.flow:cache:list`` + List all configured caches and their status if available + + + .. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:warmup`: ``neos.flow:cache:warmup`` @@ -396,7 +519,14 @@ Options The command shows the configuration of the current context as it is used by Flow itself. You can specify the configuration type and path if you want to show parts of the configuration. -./flow configuration:show --type Settings --path Neos.Flow.persistence +Display all settings: +./flow configuration:show + +Display Flow persistence settings: +./flow configuration:show --path Neos.Flow.persistence + +Display Flow Object Cache configuration +./flow configuration:show --type Caches --path Flow_Object_Classes @@ -404,7 +534,7 @@ Options ^^^^^^^ ``--type`` - Configuration type to show + Configuration type to show, defaults to Settings ``--path`` path to subconfiguration separated by "." like "Neos.Flow @@ -438,7 +568,7 @@ Options ``--path`` path to the subconfiguration separated by "." like "Neos.Flow ``--verbose`` - if TRUE, output more verbose information on the schema files which were used + if true, output more verbose information on the schema files which were used @@ -520,23 +650,6 @@ Arguments -.. _`Neos Command Reference: NEOS.FLOW neos.flow:core:shell`: - -``neos.flow:core:shell`` -************************ - -**Run the interactive Shell** - -The shell command runs Flow's interactive shell. This shell allows for -entering commands like through the regular command line interface but -additionally supports autocompletion and a user-based command history. - - - - - - - .. _`Neos Command Reference: NEOS.FLOW neos.flow:database:setcharset`: ``neos.flow:database:setcharset`` @@ -556,20 +669,19 @@ For background information on this, see: - http://stackoverflow.com/questions/766809/ - http://dev.mysql.com/doc/refman/5.5/en/alter-table.html +- https://medium.com/@adamhooper/in-mysql-never-use-utf8-use-utf8mb4-11761243e434 +- https://mathiasbynens.be/notes/mysql-utf8mb4 +- https://florian.ec/articles/mysql-doctrine-utf8/ -The main purpose of this is to fix setups that were created with Flow 2.3.x or earlier and whose -database server did not have a default collation of utf8mb4_unicode_ci. In those cases, the tables will -have a collation that does not match the default collation of later Flow versions, potentially leading -to problems when creating foreign key constraints (among others, potentially). +The main purpose of this is to fix setups that were created with Flow before version 5.0. In those cases, +the tables will have a collation that does not match the default collation of later Flow versions, potentially +leading to problems when creating foreign key constraints (among others, potentially). If you have special needs regarding the charset and collation, you *can* override the defaults with -different ones. One thing this might be useful for is when switching to the utf8mb4mb4 character set, see: - -- https://mathiasbynens.be/notes/mysql-utf8mb4 -- https://florian.ec/articles/mysql-doctrine-utf8/ +different ones. Note: This command **is not a general purpose conversion tool**. It will specifically not fix cases -of actual utf8mb4 stored in latin1 columns. For this a conversion to BLOB followed by a conversion to the +of actual utf8 stored in latin1 columns. For this a conversion to BLOB followed by a conversion to the proper type, charset and collation is needed instead. @@ -773,7 +885,7 @@ Related commands **Generate a new migration** -If $diffAgainstCurrent is TRUE (the default), it generates a migration file +If $diffAgainstCurrent is true (the default), it generates a migration file with the diff between current DB structure and the found mapping metadata. Otherwise an empty migration skeleton is generated. @@ -798,6 +910,8 @@ Options Whether to base the migration on the current schema structure ``--filter-expression`` Only include tables/sequences matching the filter expression regexp +``--force`` + Generate migrations even if there are migrations left to execute @@ -832,8 +946,6 @@ Options ``--show-migrations`` Output a list of all migrations and their status -``--show-descriptions`` - Show descriptions for the migrations (enables versions display) @@ -974,30 +1086,18 @@ Options -.. _`Neos Command Reference: NEOS.FLOW neos.flow:package:activate`: +.. _`Neos Command Reference: NEOS.FLOW neos.flow:middleware:list`: -``neos.flow:package:activate`` -****************************** - -**Activate an available package** - -This command activates an existing, but currently inactive package. - -Arguments -^^^^^^^^^ +``neos.flow:middleware:list`` +***************************** -``--package-key`` - The package key of the package to create +**Lists all configured middleware components in the order they will be executed** -Related commands -^^^^^^^^^^^^^^^^ -``neos.flow:package:deactivate`` - Deactivate a package @@ -1035,54 +1135,6 @@ Related commands -.. _`Neos Command Reference: NEOS.FLOW neos.flow:package:deactivate`: - -``neos.flow:package:deactivate`` -******************************** - -**Deactivate a package** - -This command deactivates a currently active package. - -Arguments -^^^^^^^^^ - -``--package-key`` - The package key of the package to create - - - - - -Related commands -^^^^^^^^^^^^^^^^ - -``neos.flow:package:activate`` - Activate an available package - - - -.. _`Neos Command Reference: NEOS.FLOW neos.flow:package:delete`: - -``neos.flow:package:delete`` -**************************** - -**Delete an existing package** - -This command deletes an existing package identified by the package key. - -Arguments -^^^^^^^^^ - -``--package-key`` - The package key of the package to create - - - - - - - .. _`Neos Command Reference: NEOS.FLOW neos.flow:package:freeze`: ``neos.flow:package:freeze`` @@ -1131,7 +1183,7 @@ Related commands **List available packages** Lists all locally available packages. Displays the package key, version and -package title and its state – active or inactive. +package title. @@ -1143,14 +1195,6 @@ Options -Related commands -^^^^^^^^^^^^^^^^ - -``neos.flow:package:activate`` - Activate an available package -``neos.flow:package:deactivate`` - Deactivate a package - .. _`Neos Command Reference: NEOS.FLOW neos.flow:package:refreeze`: @@ -1316,23 +1360,70 @@ Options -.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:getpath`: +.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:list`: + +``neos.flow:routing:list`` +************************** + +**List the known routes** + +This command displays a list of all currently registered routes. + + + + + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:match`: + +``neos.flow:routing:match`` +*************************** + +**Match the given URI to a corresponding route** + +This command takes an incoming URI and displays the +matched Route and the mapped routing values (if any): + +./flow routing:match "/de" --parameters="{\"requestUriHost\": \"localhost\"}" + +Arguments +^^^^^^^^^ + +``--uri`` + The incoming route, absolute or relative + + + +Options +^^^^^^^ + +``--method`` + The HTTP method to simulate (default is 'GET') +``--parameters`` + Route parameters as JSON string. Make sure to specify this option as described in the description in order to prevent parsing issues + + + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:resolve`: -``neos.flow:routing:getpath`` +``neos.flow:routing:resolve`` ***************************** -**Generate a route path** +**Build an URI for the given parameters** This command takes package, controller and action and displays the -generated route path and the selected route: +resolved URI and which route matched (if any): -./flow routing:getPath --format json Acme.Demo\\Sub\\Package +./flow routing:resolve Some.Package --controller SomeController --additional-arguments="{\"some-argument\": \"some-value\"}" Arguments ^^^^^^^^^ ``--package`` - Package key and subpackage, subpackage parts are separated with backslashes + Package key (according to "@package" route value) @@ -1340,73 +1431,86 @@ Options ^^^^^^^ ``--controller`` - Controller name, default is 'Standard' + Controller name (according to "@controller" route value), default is 'Standard' ``--action`` - Action name, default is 'index' + Action name (according to "@action" route value), default is 'index' ``--format`` - Requested Format name default is 'html' + Requested Format name (according to "@format" route value), default is 'html' +``--subpackage`` + SubPackage name (according to "@subpackage" route value) +``--additional-arguments`` + Additional route values as JSON string. Make sure to specify this option as described in the description in order to prevent parsing issues +``--parameters`` + Route parameters as JSON string. Make sure to specify this option as described in the description in order to prevent parsing issues +``--base-uri`` + Base URI of the simulated request, default ist 'http://localhost' +``--force-absolute-uri`` + Whether or not to force the creation of an absolute URI -.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:list`: +.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:show`: -``neos.flow:routing:list`` +``neos.flow:routing:show`` ************************** -**List the known routes** +**Show information for a route** -This command displays a list of all currently registered routes. +This command displays the configuration of a route specified by index number. + +Arguments +^^^^^^^^^ +``--index`` + The index of the route as given by routing:list -.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:routepath`: -``neos.flow:routing:routepath`` -******************************* +.. _`Neos Command Reference: NEOS.FLOW neos.flow:schema:validate`: -**Route the given route path** +``neos.flow:schema:validate`` +***************************** -This command takes a given path and displays the detected route and -the selected package, controller and action. +**Validate the given configurationfile againt a schema file** -Arguments -^^^^^^^^^ -``--path`` - The route path to resolve Options ^^^^^^^ -``--method`` - The request method (GET, POST, PUT, DELETE, ...) to simulate +``--configuration-file`` + path to the validated configuration file +``--schema-file`` + path to the schema file +``--verbose`` + if true, output more verbose information on the schema files which were used -.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:show`: +.. _`Neos Command Reference: NEOS.FLOW neos.flow:security:describerole`: -``neos.flow:routing:show`` -************************** +``neos.flow:security:describerole`` +*********************************** + +**Show details of a specified role** -**Show information for a route** -This command displays the configuration of a route specified by index number. Arguments ^^^^^^^^^ -``--index`` - The index of the route as given by routing:list +``--role`` + identifier of the role to describe (for example "Neos.Flow:Everybody") @@ -1508,6 +1612,27 @@ Related commands +.. _`Neos Command Reference: NEOS.FLOW neos.flow:security:listroles`: + +``neos.flow:security:listroles`` +******************************** + +**List all configured roles** + + + + + +Options +^^^^^^^ + +``--include-abstract`` + Set this flag to include abstract roles + + + + + .. _`Neos Command Reference: NEOS.FLOW neos.flow:security:showeffectivepolicy`: ``neos.flow:security:showeffectivepolicy`` @@ -1600,6 +1725,69 @@ Options +.. _`Neos Command Reference: NEOS.FLOW neos.flow:session:collectgarbage`: + +``neos.flow:session:collectgarbage`` +************************************ + +**Run garbage collection for sesions.** + +This command will remove session-data and -metadate of outdated sessions +identified by lastActivityTimestamp being older than inactivityTimeout + +!!! This is usually done automatically after shutdown for the percentage +of requests specified in the setting `Neos.Flow.session.garbageCollection.probability` + +Use this command if you need more direct control over the cleanup intervals. + + + + + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:session:destroyall`: + +``neos.flow:session:destroyall`` +******************************** + +**Destroys all sessions.** + +This special command is needed, because sessions are kept in persistent storage and are not flushed +with other caches by default. + +This is functionally equivalent to +`./flow flow:cache:flushOne Flow_Session_Storage && ./flow flow:cache:flushOne Flow_Session_MetaData` + + + + + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:signal:listconnected`: + +``neos.flow:signal:listconnected`` +********************************** + +**Lists all connected signals with their slots.** + + + + + +Options +^^^^^^^ + +``--class-name`` + if specified, only signals matching the given fully qualified class name will be shown. Note: escape namespace separators or wrap the value in quotes, e.g. "--class-name Neos\\Flow\\Core\\Bootstrap". +``--method-name`` + if specified, only signals matching the given method name will be shown. This is only useful in conjunction with the "--class-name" option. + + + + + .. _`Neos Command Reference: NEOS.FLOW neos.flow:typeconverter:list`: ``neos.flow:typeconverter:list`` @@ -1641,7 +1829,7 @@ Generates Schema documentation (XSD) for your ViewHelpers, preparing the file to be placed online and used by any XSD-aware editor. After creating the XSD file, reference it in your IDE and import the namespace in your Fluid template by adding the xmlns:* attribute(s): - + Arguments ^^^^^^^^^ @@ -1655,9 +1843,11 @@ Options ^^^^^^^ ``--xsd-namespace`` - Unique target namespace used in the XSD schema (for example "http://yourdomain.org/ns/viewhelpers"). Defaults to "http://typo3.org/ns/". + Unique target namespace used in the XSD schema (for example "http://yourdomain.org/ns/viewhelpers"). Defaults to "https://neos.io/ns/". ``--target-file`` File path and name of the generated XSD schema. If not specified the schema will be output to standard output. +``--xsd-domain`` + Domain used in the XSD schema (for example "http://yourdomain.org"). Defaults to "https://neos.io". @@ -1690,8 +1880,9 @@ exist. By using the --generate-related flag, a missing package, model or repository can be created alongside, avoiding such an error. By specifying the --generate-templates flag, this command will also create -matching Fluid templates for the actions created. This option can only be -used in combination with --generate-actions. +matching Fluid templates for the actions created. +Alternatively, by specifying the --generate-fusion flag, this command will +create matching Fusion files for the actions. The default behavior is to not overwrite any existing code. This can be overridden by specifying the --force flag. @@ -1713,8 +1904,10 @@ Options Also generate index, show, new, create, edit, update and delete actions. ``--generate-templates`` Also generate the templates for each action. +``--generate-fusion`` + If Fusion templates should be generated instead of Fluid. ``--generate-related`` - Also create the mentioned package, related model and repository if neccessary. + Also create the mentioned package, related model and repository if necessary. ``--force`` Overwrite any existing controller or template code. Regardless of this flag, the package, model and repository will never be overwritten. @@ -1842,13 +2035,19 @@ Arguments +Options +^^^^^^^ + +``--package-type`` + Optional package type, e.g. "neos-plugin + Related commands ^^^^^^^^^^^^^^^^ -``typo3.flow:package:create`` - *Command not available* +``neos.flow:package:create`` + Create a new package @@ -1887,6 +2086,35 @@ Related commands +.. _`Neos Command Reference: NEOS.KICKSTARTER neos.kickstarter:kickstart:translation`: + +``neos.kickstarter:kickstart:translation`` +****************************************** + +**Kickstart translation** + +Generates the translation files for the given package. + +Arguments +^^^^^^^^^ + +``--package-key`` + The package key of the package for the translation +``--source-language-key`` + The language key of the default language + + + +Options +^^^^^^^ + +``--target-language-keys`` + Comma separated language keys for the target translations + + + + + .. _`Neos Command Reference: NEOS.MEDIA`: Package *NEOS.MEDIA* @@ -1910,6 +2138,8 @@ Options ``--preset`` Preset name, if provided only thumbnails matching that preset are cleared +``--quiet`` + If set, only errors will be displayed. @@ -1925,7 +2155,7 @@ Options Creates thumbnail images based on the configured thumbnail presets. Optional ``preset`` parameter to only create thumbnails for a specific thumbnail preset configuration. -Additionally accepts a ``async`` parameter determining if the created thumbnails are generated when created. +Additionally, accepts a ``async`` parameter determining if the created thumbnails are generated when created. @@ -1936,6 +2166,8 @@ Options Preset name, if not provided thumbnails are created for all presets ``--async`` Asynchronous generation, if not provided the setting ``Neos.Media.asyncThumbnails`` is used +``--quiet`` + If set, only errors will be displayed. @@ -1959,6 +2191,92 @@ Options ``--simulate`` If set, this command will only tell what it would do instead of doing it right away +``--quiet`` + + + + + + +.. _`Neos Command Reference: NEOS.MEDIA neos.media:media:listvariantpresets`: + +``neos.media:media:listvariantpresets`` +*************************************** + +**List all configurations for your imageVariants.** + +Doesn't matter if configured under 'Neos.Media.variantPresets' or already deleted from this configuration. +This command will find every single one for you. + + + + + + + +.. _`Neos Command Reference: NEOS.MEDIA neos.media:media:removeunused`: + +``neos.media:media:removeunused`` +********************************* + +**Remove unused assets** + +This command iterates over all existing assets, checks their usage count and lists the assets which are not +reported as used by any AssetUsageStrategies. The unused assets can than be removed. + + + +Options +^^^^^^^ + +``--asset-source`` + If specified, only assets of this asset source are considered. For example "neos" or "my-asset-management-system +``--quiet`` + If set, only errors will be displayed. +``--assume-yes`` + If set, "yes" is assumed for the "shall I remove ..." dialogs +``--only-tags`` + Comma-separated list of asset tag labels, that should be taken into account +``--limit`` + Limit the result of unused assets displayed and removed for this run. +``--only-collections`` + Comma-separated list of asset collection titles, that should be taken into account + + + + + +.. _`Neos Command Reference: NEOS.MEDIA neos.media:media:removevariants`: + +``neos.media:media:removevariants`` +*********************************** + +**Cleanup imageVariants with provided identifier and variant name.** + +Image variants that are still configured are removed without usage check and +can be regenerated afterwards with `media:renderVariants`. + +This command will not remove any custom cropped image variants. + +Arguments +^^^^^^^^^ + +``--identifier`` + Identifier of variants to remove. +``--variant-name`` + Variants with this name will be removed (if exist). + + + +Options +^^^^^^^ + +``--quiet`` + If set, only errors and questions will be displayed. +``--assume-yes`` + If set, "yes" is assumed for the "shall I remove ..." dialog. +``--limit`` + Limit the result of unused assets displayed and removed for this run. @@ -1981,6 +2299,36 @@ Options ``--limit`` Limit the amount of thumbnails to be rendered to avoid memory exhaustion +``--quiet`` + If set, only errors will be displayed. + + + + + +.. _`Neos Command Reference: NEOS.MEDIA neos.media:media:rendervariants`: + +``neos.media:media:rendervariants`` +*********************************** + +**Render asset variants** + +Loops over missing configured asset variants and renders them. Optional ``limit`` parameter to +limit the amount of variants to be rendered to avoid memory exhaustion. + +If the re-render parameter is given, any existing variants will be rendered again, too. + + + +Options +^^^^^^^ + +``--limit`` + Limit the amount of variants to be rendered to avoid memory exhaustion +``--quiet`` + If set, only errors will be displayed. +``--recreate`` + If set, existing asset variants will be re-generated and replaced @@ -1997,7 +2345,7 @@ Package *NEOS.NEOS* ``neos.neos:domain:activate`` ***************************** -**Activate a domain record by hostname** +**Activate a domain record by hostname (with globbing)** @@ -2005,7 +2353,7 @@ Arguments ^^^^^^^^^ ``--hostname`` - The hostname to activate + The hostname to activate (globbing is supported) @@ -2026,7 +2374,7 @@ Arguments ^^^^^^^^^ ``--site-node-name`` - The nodeName of the site rootNode, e.g. "neostypo3org + The nodeName of the site rootNode, e.g. "flowneosio ``--hostname`` The hostname to match on, e.g. "flow.neos.io @@ -2049,7 +2397,7 @@ Options ``neos.neos:domain:deactivate`` ******************************* -**Deactivate a domain record by hostname** +**Deactivate a domain record by hostname (with globbing)** @@ -2057,7 +2405,7 @@ Arguments ^^^^^^^^^ ``--hostname`` - The hostname to deactivate + The hostname to deactivate (globbing is supported) @@ -2070,7 +2418,7 @@ Arguments ``neos.neos:domain:delete`` *************************** -**Delete a domain record by hostname** +**Delete a domain record by hostname (with globbing)** @@ -2078,7 +2426,7 @@ Arguments ^^^^^^^^^ ``--hostname`` - The hostname to remove + The hostname to remove (globbing is supported) @@ -2112,7 +2460,7 @@ Options ``neos.neos:site:activate`` *************************** -**Activate a site** +**Activate a site (with globbing)** This command activates the specified site. @@ -2120,7 +2468,7 @@ Arguments ^^^^^^^^^ ``--site-node`` - The node name of the site to activate + The node name of the sites to activate (globbing is supported) @@ -2138,13 +2486,12 @@ Arguments This command allows to create a blank site with just a single empty document in the default dimension. The name of the site, the packageKey must be specified. -If no ``nodeType`` option is specified the command will use `Neos.NodeTypes:Page` as fallback. The node type -must already exists and have the superType ``Neos.Neos:Document``. +The node type given with the ``nodeType`` option must already exists and have the superType ``Neos.Neos:Document``. -If no ``nodeName` option is specified the command will create a unique node-name from the name of the site. +If no ``nodeName`` option is specified the command will create a unique node-name from the name of the site. If a node name is given it has to be unique for the setup. -If the flag ``activate` is set to false new site will not be activated. +If the flag ``activate`` is set to false new site will not be activated. Arguments ^^^^^^^^^ @@ -2153,18 +2500,18 @@ Arguments The name of the site ``--package-key`` The site package +``--node-type`` + The node type to use for the site node, e.g. Amce.Com:Page Options ^^^^^^^ -``--node-type`` - The node type to use for the site node. (Default = Neos.NodeTypes:Page) ``--node-name`` The name of the site node. If no nodeName is given it will be determined from the siteName. ``--inactive`` - The new site is not activated immediately (default = false). + The new site is not activated immediately (default = false) @@ -2175,7 +2522,7 @@ Options ``neos.neos:site:deactivate`` ***************************** -**Deactivate a site** +**Deactivate a site (with globbing)** This command deactivates the specified site. @@ -2183,7 +2530,7 @@ Arguments ^^^^^^^^^ ``--site-node`` - The node name of the site to deactivate + The node name of the sites to deactivate (globbing is supported) @@ -2279,17 +2626,17 @@ Options ``neos.neos:site:prune`` ************************ -**Remove all content and related data - for now. In the future we need some more sophisticated cleanup.** - +**Remove site with content and related data (with globbing)** +In the future we need some more sophisticated cleanup. +Arguments +^^^^^^^^^ +``--site-node`` + Name for site root nodes to clear only content of this sites (globbing is supported) -Options -^^^^^^^ -``--site-node`` - Name of a site root node to clear only content of this site. @@ -2300,7 +2647,7 @@ Options ``neos.neos:user:activate`` *************************** -**Activate a user** +**Activate a user (with globbing)** This command reactivates possibly expired accounts for the given user. @@ -2312,7 +2659,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user to be activated. + The username of the user to be activated (globbing is supported) @@ -2346,7 +2693,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user + The username of the user (globbing is supported) ``--role`` Role to be added to the user, for example "Neos.Neos:Administrator" or just "Administrator @@ -2411,7 +2758,7 @@ Options ``neos.neos:user:deactivate`` ***************************** -**Deactivate a user** +**Deactivate a user (with globbing)** This command deactivates a user by flagging all of its accounts as expired. @@ -2423,7 +2770,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user to be deactivated. + The username of the user to be deactivated (globbing is supported) @@ -2442,7 +2789,7 @@ Options ``neos.neos:user:delete`` ************************* -**Delete a user** +**Delete a user (with globbing)** This command deletes an existing Neos user. All content and data directly related to this user, including but not limited to draft workspace contents, will be removed as well. @@ -2458,7 +2805,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user to be removed + The username of the user to be removed (globbing is supported) @@ -2506,7 +2853,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user + The username of the user (globbing is supported) ``--role`` Role to be removed from the user, for example "Neos.Neos:Administrator" or just "Administrator @@ -2683,39 +3030,6 @@ Options -.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:discardall`: - -``neos.neos:workspace:discardall`` -********************************** - -**Discard changes in workspace <b>(DEPRECATED)</b>** - -This command discards all modified, created or deleted nodes in the specified workspace. - -Arguments -^^^^^^^^^ - -``--workspace-name`` - Name of the workspace, for example "user-john - - - -Options -^^^^^^^ - -``--verbose`` - If enabled, information about individual nodes will be displayed - - - -Related commands -^^^^^^^^^^^^^^^^ - -``neos.neos:workspace:discard`` - Discard changes in workspace - - - .. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:list`: ``neos.neos:workspace:list`` @@ -2763,39 +3077,6 @@ Options -.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:publishall`: - -``neos.neos:workspace:publishall`` -********************************** - -**Publish changes of a workspace <b>(DEPRECATED)</b>** - -This command publishes all modified, created or deleted nodes in the specified workspace to the live workspace. - -Arguments -^^^^^^^^^ - -``--workspace-name`` - Name of the workspace, for example "user-john - - - -Options -^^^^^^^ - -``--verbose`` - If enabled, information about individual nodes will be displayed - - - -Related commands -^^^^^^^^^^^^^^^^ - -``neos.neos:workspace:publish`` - Publish changes of a workspace - - - .. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:rebase`: ``neos.neos:workspace:rebase`` diff --git a/Neos.Neos/Documentation/References/EelHelpersReference.rst b/Neos.Neos/Documentation/References/EelHelpersReference.rst index f48f614ca07..2a36c870d79 100644 --- a/Neos.Neos/Documentation/References/EelHelpersReference.rst +++ b/Neos.Neos/Documentation/References/EelHelpersReference.rst @@ -3,7 +3,7 @@ Eel Helpers Reference ===================== -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Eel Helpers Reference: Api`: @@ -2091,14 +2091,15 @@ Replace occurrences of a search string inside the string Example:: String.replace("canal", "ana", "oo") == "cool" + String.replace("cool gridge", ["oo", "gri"], ["ana", "bri"]) == "canal bridge" Note: this method does not perform regular expression matching, @see pregReplace(). -* ``string`` (string) The input string -* ``search`` (string) A search string -* ``replace`` (string) A replacement string +* ``string`` (array|string|null) The input string +* ``search`` (array|string|null) A search string +* ``replace`` (array|string|null) A replacement string -**Return** (string) The string with all occurrences replaced +**Return** (array|string|string[]) The string with all occurrences replaced String.sha1(string) ^^^^^^^^^^^^^^^^^^^ diff --git a/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst b/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst index d5e8781214e..582e91c9267 100644 --- a/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst +++ b/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst @@ -3,7 +3,7 @@ FlowQuery Operation Reference ============================= -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`FlowQuery Operation Reference: add`: diff --git a/Neos.Neos/Documentation/References/Signals/ContentRepository.rst b/Neos.Neos/Documentation/References/Signals/ContentRepository.rst index 1f7c9b2e2b8..66dd6924281 100644 --- a/Neos.Neos/Documentation/References/Signals/ContentRepository.rst +++ b/Neos.Neos/Documentation/References/Signals/ContentRepository.rst @@ -3,7 +3,7 @@ Content Repository Signals Reference ==================================== -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Content Repository Signals Reference: Context (``Neos\ContentRepository\Domain\Service\Context``)`: diff --git a/Neos.Neos/Documentation/References/Signals/Flow.rst b/Neos.Neos/Documentation/References/Signals/Flow.rst index 2c92fd5eed6..359257c7ed2 100644 --- a/Neos.Neos/Documentation/References/Signals/Flow.rst +++ b/Neos.Neos/Documentation/References/Signals/Flow.rst @@ -3,7 +3,7 @@ Flow Signals Reference ====================== -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Flow Signals Reference: AbstractAdvice (``Neos\Flow\Aop\Advice\AbstractAdvice``)`: diff --git a/Neos.Neos/Documentation/References/Signals/Media.rst b/Neos.Neos/Documentation/References/Signals/Media.rst index c731caf20f0..350cb44df2c 100644 --- a/Neos.Neos/Documentation/References/Signals/Media.rst +++ b/Neos.Neos/Documentation/References/Signals/Media.rst @@ -3,7 +3,7 @@ Media Signals Reference ======================= -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Media Signals Reference: AssetCollectionController (``Neos\Media\Browser\Controller\AssetCollectionController``)`: diff --git a/Neos.Neos/Documentation/References/Signals/Neos.rst b/Neos.Neos/Documentation/References/Signals/Neos.rst index e453470f856..937847a87a7 100644 --- a/Neos.Neos/Documentation/References/Signals/Neos.rst +++ b/Neos.Neos/Documentation/References/Signals/Neos.rst @@ -3,7 +3,7 @@ Neos Signals Reference ====================== -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Neos Signals Reference: AbstractCreate (``Neos\Neos\Ui\Domain\Model\Changes\AbstractCreate``)`: diff --git a/Neos.Neos/Documentation/References/Validators/Flow.rst b/Neos.Neos/Documentation/References/Validators/Flow.rst index 6f1db83cbea..fe603202ce7 100644 --- a/Neos.Neos/Documentation/References/Validators/Flow.rst +++ b/Neos.Neos/Documentation/References/Validators/Flow.rst @@ -3,7 +3,7 @@ Flow Validator Reference ======================== -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Flow Validator Reference: AggregateBoundaryValidator`: diff --git a/Neos.Neos/Documentation/References/Validators/Media.rst b/Neos.Neos/Documentation/References/Validators/Media.rst index 2b9badece72..9e9407aff36 100644 --- a/Neos.Neos/Documentation/References/Validators/Media.rst +++ b/Neos.Neos/Documentation/References/Validators/Media.rst @@ -3,7 +3,7 @@ Media Validator Reference ========================= -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Media Validator Reference: ImageOrientationValidator`: diff --git a/Neos.Neos/Documentation/References/Validators/Party.rst b/Neos.Neos/Documentation/References/Validators/Party.rst index f6e6cc52989..7f7479f57ad 100644 --- a/Neos.Neos/Documentation/References/Validators/Party.rst +++ b/Neos.Neos/Documentation/References/Validators/Party.rst @@ -3,7 +3,7 @@ Party Validator Reference ========================= -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Party Validator Reference: AimAddressValidator`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst b/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst index 3708b9567e4..b073d7b8500 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst @@ -3,7 +3,7 @@ Content Repository ViewHelper Reference ####################################### -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Content Repository ViewHelper Reference: PaginateViewHelper`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst b/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst index 033b515e2d1..6f6aaf4574e 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst @@ -3,7 +3,7 @@ FluidAdaptor ViewHelper Reference ################################# -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`FluidAdaptor ViewHelper Reference: f:debug`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Form.rst b/Neos.Neos/Documentation/References/ViewHelpers/Form.rst index f6a1c13b1b6..032e57f64b7 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Form.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Form.rst @@ -3,7 +3,7 @@ Form ViewHelper Reference ######################### -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Form ViewHelper Reference: neos.form:form`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst b/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst index e74bb37cbc6..d578688b50b 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst @@ -3,7 +3,7 @@ Fusion ViewHelper Reference ########################### -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Fusion ViewHelper Reference: fusion:render`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Media.rst b/Neos.Neos/Documentation/References/ViewHelpers/Media.rst index 2f1865ed761..d25b770036d 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Media.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Media.rst @@ -3,7 +3,7 @@ Media ViewHelper Reference ########################## -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Media ViewHelper Reference: neos.media:fileTypeIcon`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst b/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst index e226405aeee..c5191e870e1 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst @@ -3,7 +3,7 @@ Neos ViewHelper Reference ######################### -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`Neos ViewHelper Reference: neos:backend.authenticationProviderLabel`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst b/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst index 4e8b815047f..6a3a594c574 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst @@ -3,7 +3,7 @@ TYPO3 Fluid ViewHelper Reference ################################ -This reference was automatically generated from code on 2023-09-28 +This reference was automatically generated from code on 2023-10-21 .. _`TYPO3 Fluid ViewHelper Reference: f:alias`: