Skip to main content
Keel Docs Showcase

Console commands

keel:setup

Checks the install, then creates config/packages/keel.yaml by asking ten questions about the project, with suggestions taken from it (image folders, folders with one subfolder per option, classes with object counts, link generators, status fields, document properties).

bash
bin/console keel:setup --check     # only check the install; writes nothing
bin/console keel:setup             # check, ask and write
bin/console keel:setup --dry-run   # check and ask, then print the file instead of writing it
bin/console keel:setup --force     # replace an existing keel.yaml
Section
0 · Install checkbundle, routes, licence, sodium, assets and Studio build, settings store, Keel's tables (✖ when one is missing), waiting sort indexes (!), search index, PHP upload size, the names in keel.yaml, PHP memory, Pimcore's maintenance
1 · Name and colourstitle, subtitle, theme.accent, theme.brand
2 · Imagesimage_folder, upload_folder
3 · Header switcherscope
4 · Content classesclasses.exclude
5 · Assignmentsassignments.classes
6 · Website pagesurls
7 · Namescollections.<list-key>.singular
8 · Asset folders named after objectsfolder_labels
9 · Interface languageslanguages
10 · Keel page checkpage_check.robots_property, page_check.wcag

--check exits with code 1 when a line is marked ✖ (one line per problem, each with its fix), so it fits in a deploy script. Without --force, an existing keel.yaml is never overwritten. Console texts are English only.

Every question explained: First configuration with keel:setup. Every line of the check: Install → Check it works.

keel:install-tables

Creates Keel's eight tables (keel_bulk_job, keel_bulk_item, keel_completeness_rule, keel_completeness, keel_follow, keel_import_stage, keel_history, keel_history_item) and the columns a new version adds, where they are missing, and moves History entries an older Keel kept in Pimcore's settings store into keel_history. With everything in place it changes nothing, so it belongs in every deploy, after cache:clear. It does the same as bin/console pimcore:bundle:install KeelBundle. The database user needs CREATE TABLE for this step.

bash
bin/console keel:install-tables            # create what is missing, move old History entries
bin/console keel:install-tables --dry-run  # only print what is missing

keel:sort-indexes

Lists of 5,000 items and more sort through an index keel_s_<column> on the class's query table. This command adds the missing ones and drops those no longer needed: one ALTER TABLE per table, each change printed. Without them everything works; sorting a big list is slower. To have cache:clear / cache:warmup do it instead, set sort_indexes.on_cache_warmup: true (off by default).

bash
bin/console keel:sort-indexes --dry-run   # print the plan
bin/console keel:sort-indexes             # make the changes
bin/console keel:sort-indexes --drop      # remove all of Keel's sort indexes

keel:history:migrate

Moves Setup → History entries from Pimcore's settings store (scope keel_history, where Keel kept them before the keel_history tables) into the tables, with their ids. keel:install-tables does the same, and Keel does it by itself before the first History request; this command does only that step.

bash
bin/console keel:history:migrate            # move them
bin/console keel:history:migrate --dry-run  # only count what is waiting

keel:completeness

Works out completeness scores again, for classes with a rule that is on.

bash
bin/console keel:completeness            # a job per class, for the worker
bin/console keel:completeness Tour       # one class
bin/console keel:completeness Tour --now # right here, without a worker

keel:check-editables

Checks that Keel's content editor can edit and save every content field of the given pages – it reads each field the way the editor does, converts it to what the editor would save and compares the result with what Pimcore holds. Nothing is saved.

bash
bin/console keel:check-editables /about /contact   # page paths or IDs
bin/console keel:check-editables --all             # every page

Each field is reported as ok or FAIL; the command exits with code 1 when anything fails – handy in CI after adding new bricks or editable types. Pimcore's own normalisations (a typed path that becomes an internal link, an added subtype) count as ok.