Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 6.33 KB

console-commands.md

File metadata and controls

107 lines (75 loc) · 6.33 KB
Raw

Console Commands

Neo offers console commands for managing Neo blocks, block types, block type groups and fields.

neo/block-type-groups/delete

Deletes a Neo block type group.

Options

  • --group-id (required): The ID of the block type group to delete.
  • --delete-block-types: Delete block types belonging to the block type group. If omitted, the block types will be reassigned to the previous group in the field (if any).

neo/block-type-groups/edit

Edits a Neo block type group.

Options

  • --group-id (required): The ID of the block type group to edit.
  • --set-name: A new name to set for the block type group.
  • --blank-name: Set a blank name for the block type group.
  • --dropdown: What behaviour should be used for showing the block type group's dropdown — either 'show', 'hide', or 'global'.

Please note that at most one of --set-name and --blank-name can be specified.

neo/block-types/convert-icons

Converts the icon settings from the asset source format to the filename format, for all block types that have an icon asset set but not a filename. See the documentation for the blockTypeIconSelectMode plugin setting for more information.

neo/block-types/convert-to-entry-type

Converts a Neo block type to an entry type, and assigns that entry type as associated with the original block type.

The block type must not already be associated with an entry type, and an entry type with the same handle must not already exist. Any parent block condition rules associated with any of the block type's field layout tabs or elements will be removed.

Options

  • --type-id: The ID of the block type to convert.
  • --handle: The handle of the block type to convert.
  • --field-id: The field ID of the block type to convert.

One of --type-id and --handle must be specified, and if --handle is specified and the specified handle is used on more than one Neo field, --field-id must also be specified.

neo/block-types/delete

Deletes a Neo block type.

Options

  • --type-id: The ID of the block type to delete.
  • --handle: The handle of the block type to delete.
  • --field-id: The field ID of the block type to delete.

One of --type-id and --handle must be specified, and if --handle is specified and the specified handle is used on more than one Neo field, --field-id must also be specified.

neo/block-types/edit

Edits a Neo block type.

Options

  • --type-id: The ID of the block type to edit.
  • --handle: The handle of the block type to edit.
  • --field-id: The field ID of the block type to edit.
  • --set-name: A new name to set for the block type.
  • --set-handle: A new handle to set for the block type.
  • --set-description: A new description to set for the block type.
  • --unset-description: Whether to remove the block type's description.
  • --set-enabled: Whether to set the block type as being allowed to be used.
  • --unset-enabled: Whether to set the block type as not being allowed to be used.
  • --set-min-blocks: A new min blocks value to set for the block type. Set this to 0 to remove the limit.
  • --set-max-blocks: A new max blocks value to set for the block type. Set this to 0 to remove the limit.
  • --set-min-sibling-blocks: A new min sibling blocks value to set for the block type. Set this to 0 to remove the limit.
  • --set-max-sibling-blocks: A new max sibling blocks value to set for the block type. Set this to 0 to remove the limit.
  • --set-min-child-blocks: A new min child blocks value to set for the block type. Set this to 0 to remove the limit.
  • --set-max-child-blocks: A new max child blocks value to set for the block type. Set this to 0 to remove the limit.
  • --set-group-child-block-types: Whether to set the block type's child block types as being shown in their groups.
  • --unset-group-child-block-types: Whether to set the block type's child block types as not being shown in their groups.
  • --set-child-blocks: The child block types of this block type, either as comma-separated block type handles, or the string '*' representing all of the Neo field's block types.
  • --unset-child-blocks: Whether to set this block type as having no child block types.
  • --set-top-level: Whether to set the block type as being allowed at the top level.
  • --unset-top-level: Whether to set the block type as not being allowed at the top level.

The following restrictions exist on using options:

  • One of --type-id and --handle must be specified, and if --handle is specified and the specified handle is used on more than one Neo field, --field-id must also be specified
  • At most one of --set-description and --unset-description may be used
  • At most one of --set-enabled and --unset-enabled may be used
  • At most one of --set-top-level and --unset-top-level may be used
  • At most one of --set-group-child-block-types and --unset-group-child-block-types may be used
  • At most one of --set-child-blocks and --unset-child-blocks may be used

neo/block-types/fix-field-layouts

Ensures each block type has a unique field layout. Checks all block types and has no options.

neo/fields/fix-block-structure-site-ids

Changes null block structure site IDs to the primary site ID. Checks all block structures and has no options.

neo/fields/reapply-propagation-method

This command reapplies the propagation methods for Neo fields' blocks, optionally on a per-block-structure basis.

Options

  • --field-id: The ID(s) of the fields whose blocks should have the propagation method reapplied. If this option is omitted, then all Neo fields will be used.
  • --by-block-structure: This option is usually unnecessary, but may be required if omitting it causes an error due to a bug in Neo versions prior to 2.8.14. Note that this may create many jobs in the queue.
  • --with-propagation-method: A comma-separated list of propagation methods that Neo fields need to have, in order to have their propagation methods reapplied - accepted options are none, siteGroup, language, custom, and all. If not specified, it will default to fields with any propagation method except "Save blocks to all sites the owner element is saved in".

resave/neo-blocks

This command resaves Neo blocks and has the same options as Craft 4's in-built resave/matrix-blocks command.