Skip to the content
Documentation
Version 6.x Supported

Console commands (6.x)

Written by Graham Brookins, Updated by Graham Brookins
No ratings yet

Summary

The scripts in bin/php of Exponential 6.0.15 that the 4.x reference does not describe. Each one runs as php bin/php/<name>.php or, through the console, as ./bin/php/console exp:<name>.

Commands

Console command Script Description Help
exp:accesscheck bin/php/accesscheck.php Check what a user may do with a node or object (content/read, edit, ...) and which limitation refuses it Generated example
exp:addanonymouspublicpolicies bin/php/addanonymouspublicpolicies.php Give the Anonymous role the public policies it lacks: user/register, rss/feed, tags/view, the newsletter's public views (dry run unless --apply) Generated example
exp:adddefaultstates bin/php/adddefaultstates.php Give every content object the default state of each state group it has no state of (dry run unless --apply) Generated example
exp:addeditorpolicies bin/php/addeditorpolicies.php Give the Editor role the everyday policies it lacks: content/hide, content/restore, content/reverserelatedlist, ezmultiupload, the image editor, the own account, the UI switch, the class sets of editorpolicies.ini, no duplicates (dry run unless --apply) Generated example
exp:addexphelpreadpolicy bin/php/addexphelpreadpolicy.php Grant exphelp/read (the help system) to the Editor role or the roles named (dry run unless --apply) Generated example
exp:addmembermanagement bin/php/addmembermanagement.php Set up member management from membermanagement.ini: the role that lets a group (default Editors) manage the accounts of another (default Members), never Administrator users or Editors (dry run unless --apply) Generated example
exp:addoauthauthorizepolicy bin/php/addoauthauthorizepolicy.php Grant oauth/authorize to the roles that let users sign in (6.0.15 upgrade; dry run unless --apply) Generated example
exp:adduserapproval bin/php/adduserapproval.php Set up the approval of new accounts in a user group (default: new Editors wait for the Administrator users): the workflow event on content/publish before and the role that lets the requesters create such accounts; --mode=section sets up the optional alternative, a section Staff with the plain approval event (both a dry run unless --apply) Generated example
exp:audit bin/php/audit.php Audit log: tail, show one event, verify the hash chains, list the channels (the manage actions are a dry run unless --apply) Generated example
exp:benchmark bin/php/benchmark.php Measure this installation: page timings over HTTP, A/B between servers, kernel probes, regression check Generated example
exp:cache bin/php/cache.php Clear and inspect caches by tag, id or all: content, static, HTTP, Velocity, OPcache, APCu Generated example
exp:changelog2xmltext bin/php/changelog2xmltext.php Convert a Changelog file to XML text format and print it to standard output Generated example
exp:checkclasses bin/php/checkclasses.php Load every declared class and report the ones PHP refuses to load Generated example
exp:checkcodestyle bin/php/checkcodestyle.php   Generated example
exp:checkdbfiles bin/php/checkdbfiles.php Verify the database update files against the upgrade path; reports missing or stray files Generated example
exp:checkmanifest bin/php/checkmanifest.php   Generated example
exp:cleanuprss bin/php/cleanuprss.php Trim RSS-imported content, keeping the newest items of each active import (dry run unless --apply) Generated example
exp:clusterize bin/php/clusterize.php Move var files into the database cluster storage (-u moves them back) Generated example
exp:collaborationsampledata bin/php/collaborationsampledata.php Build sample content for the collaboration tool (approvals, comments, groups), or remove it again (dry run unless --apply) Generated example
exp:configphp bin/php/configphp.php List, read, set and unset the define() settings of config.php, typed and checked with php -l, documented by config.php-RECOMMENDED (set and unset: dry run unless --apply) Generated example
exp:contentcheck bin/php/contentcheck.php Content checks: build the reference index, list the unused assets and the broken relations below a node, list the missing files, scan the storage files (report only; --fix, --quarantine and --fix-permissions are a dry run unless --apply) Generated example
exp:convertezenumtoezselection bin/php/convertezenumtoezselection.php   Generated example
exp:convertprice2multiprice bin/php/convertprice2multiprice.php Convert content objects with 'price' datatype attributes to 'multiprice' Generated example
exp:dfscleanup bin/php/dfscleanup.php Check database and DFS files against each other (-S, -B) and delete nonexistent ones (-D) Generated example
exp:expbackfillordersiteaccess bin/php/expbackfillordersiteaccess.php Infer the siteaccess of orders placed before ezorder.siteaccess was recorded (dry run unless --apply) Generated example
exp:expcontentjob bin/php/expcontentjob.php Run, list, resume and cancel content jobs: large subtree removes and copies in batches Generated example
exp:expfetch bin/php/expfetch.php The system card: the Exponential "e" next to the facts of this installation, its engine and its machine, with health hints (exp:info adds an inventory, exp:about the project) Generated example
exp:expgraphqlbench bin/php/expgraphqlbench.php Measure the speed of the GraphQL API against decision 18: cached GET, 304, cached POST, a cached answer through the kernel and an uncached query, N requests each, with median, p95 and max Generated example
exp:expgraphqldisable bin/php/expgraphqldisable.php Switch the GraphQL API, or only its mutations, off for every siteaccess or for some; a dry run unless --apply Generated example
exp:expgraphqlenable bin/php/expgraphqlenable.php Switch the GraphQL API on in one command: the siteaccesses, the mutations, CORS for a front end, an API key, the schema, a curl example; a dry run unless --apply Generated example
exp:expgraphqlkeys bin/php/expgraphqlkeys.php The personal API keys of the GraphQL API: list them, make one for a user (the token is shown once) or revoke one; a dry run unless --apply Generated example
exp:expgraphqlpersist bin/php/expgraphqlpersist.php Store GraphQL queries on the server as persisted queries (called by name or SHA-256), list them or remove them; a dry run unless --apply Generated example
exp:expgraphqlquery bin/php/expgraphqlquery.php Run a GraphQL query from the console, as a user of the installation (anonymous unless --as names one), and print the answer Generated example
exp:expgraphqlschema bin/php/expgraphqlschema.php Print or write the GraphQL schema of a siteaccess: the schema language (sdl), the introspection result (json) or the classes and their fields (summary) Generated example
exp:expgraphqlstarter bin/php/expgraphqlstarter.php Generate a starter front end (Next.js, Nuxt, Astro, plain HTML or Expo) that reads the site through the GraphQL API, with queries from the live schema; a dry run unless --apply Generated example
exp:expgraphqlstatus bin/php/expgraphqlstatus.php The GraphQL API of a siteaccess: switched on or off, end point, library, limits, introspection, naming, schema hash, classes and datatypes without a mapping Generated example
exp:expgraphqlwebhooks bin/php/expgraphqlwebhooks.php The webhooks of the GraphQL API: list them, add or change one (with a new signing secret), remove one, send a test, deliver now, read the delivery log; a dry run unless --apply Generated example
exp:exphelp bin/php/exphelp.php The help system on the command line: build and describe the index of doc/, search it, show a page's metadata, check its links and images Generated example
exp:exphelpcontent bin/php/exphelpcontent.php Help maintained as content: create the help classes, sections, states, tree and roles (idempotent), check the topics against the style guide, seed the glossary and topics, report and uninstall (the changing actions are a dry run unless --apply) Generated example
exp:exphelpexamples bin/php/exphelpexamples.php Generate the reference examples of the help below doc/eng-us/examples/ from the code: template operators and functions, fetch functions, module views, policies, INI settings, datatypes, workflow events, cronjobs, console commands and extension points Generated example
exp:explogs bin/php/explogs.php The log viewer on the command line: list the log files, follow one, search them and their rotations, find an error reference and the lines of its request (masked by default); rotate logs and prune their archives (dry run unless --apply) Generated example
exp:exploremipsumfill bin/php/exploremipsumfill.php Fill a translation of objects in a test language (Lorem Ipsum, qlo-ZZ) with lorem ipsum text (dry run unless --apply) Generated example
exp:explovestack bin/php/explovestack.php Check an installation coming from LoveStack (read-only), and record its database as Exponential's (migrate) Generated example
exp:expmigrationcaption bin/php/expmigrationcaption.php Take a caption of the installation now (database, storage, settings, the commits of the code), or list the captions; a dry run unless --apply Generated example
exp:expmigrationcheck bin/php/expmigrationcheck.php Check migration files without running them: names, headers, order, PHP syntax and classes (the lint for CI) Generated example
exp:expmigrationconvert bin/php/expmigrationconvert.php Convert YAML migrations of the migration bundle of the Symfony based platform into YAML migrations of Exponential: a file or every .yml file of a folder, step by step, what does not convert listed at the top of the new file; a dry run unless --apply Generated example
exp:expmigrationdeploy bin/php/expmigrationdeploy.php Deploy this installation's migrations to one or many remotes at once, in sync: preflight and verify on all, then switch all, or take all back Generated example
exp:expmigrationdryrun bin/php/expmigrationdryrun.php Dry run of the pending migrations: the plan, and with --simulate a run in a transaction that is rolled back (--diff shows what changed) Generated example
exp:expmigrationgenerate bin/php/expmigrationgenerate.php Write a new migration file: --skeleton writes an empty migration (PHP, or with --type=yml, sql, ini or graphql that kind); --from-recording turns a recording of changes into a YAML migration; --from-content, --from-class, --from-role, --from-section and --from-settings turn what the installation has into one; --from-diff turns what changed since a caption, another installation or a database dump into one; a dry run unless --apply Generated example
exp:expmigrationheal bin/php/expmigrationheal.php Self-healing before a migration run: a stale run lock, missing migration folders, file modes, caches (what a deploy may fix on a remote) Generated example
exp:expmigrationmigrate bin/php/expmigrationmigrate.php Run the pending migrations: a dry run unless --apply; captions before and after, restore on failure, commit, tag and push Generated example
exp:expmigrationpush bin/php/expmigrationpush.php Push the migration runs whose push failed (push state pending) to the remote of the migrations repository; a dry run unless --apply Generated example
exp:expmigrationrecorddiscard bin/php/expmigrationrecorddiscard.php Discard a recording of changes: the recording and every event it captured are removed (a running one stops recording); a dry run unless --apply Generated example
exp:expmigrationrecordlist bin/php/expmigrationrecordlist.php List the recordings of changes, running and stopped, the newest first, with their kind, state and number of events Generated example
exp:expmigrationrecordshow bin/php/expmigrationrecordshow.php Show a recording of changes: every event it captured as the migration step it stands for, or with --plan the steps a migration of it would have Generated example
exp:expmigrationrecordstart bin/php/expmigrationrecordstart.php Start a recording of changes: one user's own changes (a session recording) or every change of the site (--site-wide), kept as the steps of a YAML migration; a dry run unless --apply Generated example
exp:expmigrationrecordstatus bin/php/expmigrationrecordstatus.php The recordings of changes that run: the site-wide window and the user's own recording, with how much each has recorded; repairs the file of running recordings Generated example
exp:expmigrationrecordstop bin/php/expmigrationrecordstop.php Stop a recording of changes: the one named, a user's own (--user) or the site-wide window (--site-wide); its events stay for exp:migration:generate --from-recording; a dry run unless --apply Generated example
exp:expmigrationremotelist bin/php/expmigrationremotelist.php The remotes migrations can be deployed to (migration.ini [RemoteSettings]), with their groups and any problem of their settings; connects to none Generated example
exp:expmigrationremotestatus bin/php/expmigrationremotestatus.php The migration state of remotes, read in parallel (reachable, version, lock, done, pending, failed), whether they are in sync, and the latest deploys Generated example
exp:expmigrationreposplit bin/php/expmigrationreposplit.php Split the migrations folder of the installation's git checkout into a repository of its own with its history (every commit that changed it, same authors, dates and messages); a dry run unless --apply Generated example
exp:expmigrationresume bin/php/expmigrationresume.php Resume a migration run that failed or was interrupted: the migrations still pending run again; a dry run unless --apply Generated example
exp:expmigrationrollback bin/php/expmigrationrollback.php Take migrations back: a run (its caption restored), one migration (its down()) or, for experts, any caption; a dry run unless --apply Generated example
exp:expmigrationstatus bin/php/expmigrationstatus.php Migration status: every migration with its state (done, pending, not-needed, failed, unknown), the latest runs and what waits Generated example
exp:exppatterncatalogue bin/php/exppatterncatalogue.php   Generated example
exp:exprepair bin/php/exprepair.php Repair queue of the missing-libraries error page: --create-key, --disable, --status, --run Generated example
exp:expstaticbuild bin/php/expstaticbuild.php Build a static copy of a target's siteaccess into its folder (static publishing): crawled as the anonymous user, links rewritten, files collected, extras and manifest written Generated example
exp:expstaticdiff bin/php/expstaticdiff.php What the last static build of a target changed, whether its folder still matches the manifest, and whether every link of it works when served below a path Generated example
exp:expstaticdns bin/php/expstaticdns.php Check the DNS records of a custom domain for GitHub Pages: the A, AAAA and CNAME records compared with GitHub's addresses, and what to change Generated example
exp:expstaticgithub bin/php/expstaticgithub.php Set a static publishing target up on GitHub (the repository, GitHub Pages from the branch or Actions, the custom domain, HTTPS), show its state there, or sign in with GitHub Generated example
exp:expstatickeys bin/php/expstatickeys.php Make or show the SSH deploy key of a static publishing target: ed25519, the private half in the secret store, the public half to add to the repository Generated example
exp:expstaticpublish bin/php/expstaticpublish.php Publish a target's static build (static publishing): commit it in the target's git repository, tag it static/<target>/<n> and push it, never forced Generated example
exp:expstaticpush bin/php/expstaticpush.php Push the static publishing targets whose push failed again (runs with push state pending), never forced Generated example
exp:expstaticrollback bin/php/expstaticrollback.php Roll a static publishing target back to an earlier publish: a new commit with the files of that tag, tagged and pushed; the history stays Generated example
exp:expstaticserve bin/php/expstaticserve.php Preview the static build of a target locally: PHP's built-in web server serves its folder below the target's base path, as GitHub Pages serves a project site Generated example
exp:expstaticstatus bin/php/expstaticstatus.php The state of a static publishing target: its git repository, the credential (never its value), the last runs, waiting pushes and stale pages Generated example
exp:expstatictargets bin/php/expstatictargets.php List the targets of static publishing (staticcache.ini [Target_<id>]) with their siteaccess, links and folder, and check each one Generated example
exp:exptemplatecheck bin/php/exptemplatecheck.php Check templates of every engine (.tpl, .stpl, .twig, .html.twig) for valid syntax: files, directories, designs, extensions, siteaccesses; levels syntax/compile/strict; text, json, jsonl, junit, checkstyle, github and sarif output Generated example
exp:exptemplateconvert bin/php/exptemplateconvert.php Convert the templates of a design from one template engine to another (--from-engine, --to-engine: tpl, stpl, twig); --dry-run, --file, --force, --override-ini, --twig-suffix Generated example
exp:exptemplateconvertdiff bin/php/exptemplateconvertdiff.php Print the conversion of one template to another engine on stdout, without writing anything (--file, --to-engine, --from-engine) Generated example
exp:exptemplateconvertstpltotpl bin/php/exptemplateconvertstpltotpl.php Convert the Smarty templates (.stpl) of a design to Exponential templates (.tpl); --dry-run, --file, --force, --override-ini Generated example
exp:exptemplateconvertstpltotwig bin/php/exptemplateconvertstpltotwig.php Convert the Smarty templates (.stpl) of a design to Twig templates (.twig); --dry-run, --file, --force, --override-ini, --twig-suffix Generated example
exp:exptemplateconverttpltostpl bin/php/exptemplateconverttpltostpl.php Convert the Exponential templates (.tpl) of a design to Smarty templates (.stpl); --dry-run, --file, --force, --override-ini Generated example
exp:exptemplateconverttpltotwig bin/php/exptemplateconverttpltotwig.php Convert the Exponential templates (.tpl) of a design to Twig templates (.twig); --dry-run, --file, --force, --override-ini, --twig-suffix Generated example
exp:exptemplateconverttwigtostpl bin/php/exptemplateconverttwigtostpl.php Convert the Twig templates (.twig) of a design to Smarty templates (.stpl); --dry-run, --file, --force, --override-ini Generated example
exp:exptemplateconverttwigtotpl bin/php/exptemplateconverttwigtotpl.php Convert the Twig templates (.twig) of a design to Exponential templates (.tpl); --dry-run, --file, --force, --override-ini Generated example
exp:exptemplateengines bin/php/exptemplateengines.php List the template engines: library found or not, version, file endings, settings, security policy, compiled-template cache Generated example
exp:expuser2fa bin/php/expuser2fa.php Two-step sign-in and passkeys of an account: show them; reset the second step for someone who lost the phone, remove the passkeys of a lost device (changes are a dry run unless --apply) Generated example
exp:expuserapprove bin/php/expuserapprove.php Approve a waiting registration (activate the account, or accept its approval item and publish it), or reject it with --reject, as Users > Unactivated and the approval item do (a dry run unless --apply) Generated example
exp:expuseraudit bin/php/expuseraudit.php The user audit log of an account (Users > Audit): what happened to it and what it did, newest first, filtered by event, result and days Generated example
exp:expuserbulk bin/php/expuserbulk.php Disable, enable, delete, approve, reject or unlock every account the list filters select, each as the single command does it; --apply needs --confirm with the number the dry run showed Generated example
exp:expuserchecklogin bin/php/expuserchecklogin.php Check whether a password read from standard input signs an account in (right password, enabled, not locked), for scripts and health checks; never counts as a failed sign-in Generated example
exp:expusercreate bin/php/expusercreate.php Create a user account through the content publish, as the administration does (its workflows and the approval of new accounts run): login, e-mail, names, groups, and a password from standard input, a generated one or the activation mail (a dry run unless --apply) Generated example
exp:expuserdelete bin/php/expuserdelete.php Remove a user account for good, as the administration does; refuses the anonymous user, the administrator accounts, the user who acts and the last administrator (a dry run unless --apply) Generated example
exp:expuserdisable bin/php/expuserdisable.php Disable a user account and end its sessions, as Edit user settings does; refuses the protected accounts and the last administrator (a dry run unless --apply) Generated example
exp:expuseredit bin/php/expuseredit.php Change a user account: e-mail address, login, first and last name, groups added or removed, the main group (a dry run unless --apply) Generated example
exp:expuserenable bin/php/expuserenable.php Enable a disabled user account again, as Edit user settings does; an account that was never activated is approved with exp:user:approve instead (a dry run unless --apply) Generated example
exp:expuserexport bin/php/expuserexport.php Export the accounts the list filters select as CSV or JSON: login, e-mail, names, state, groups, last visit (never a password or its hash) Generated example
exp:expusergroups bin/php/expusergroups.php User groups: list the group tree with its members, create, rename and move a group, remove an empty group to the trash (changes are a dry run unless --apply) Generated example
exp:expuserhygiene bin/php/expuserhygiene.php The counts of Users > Hygiene: accounts per state (disabled, unactivated, pending, locked, never signed in, inactive, orphaned, duplicate logins and addresses), each with the command that lists them Generated example
exp:expuserimport bin/php/expuserimport.php Import accounts from a CSV or JSON file, each created as exp:user:create creates it, with the activation mail or disabled; never a password from the file (a dry run that checks every row unless --apply) Generated example
exp:expuserlist bin/php/expuserlist.php List user accounts: filter by state (enabled, disabled, unactivated, pending, locked, never signed in, inactive ...), group and search, with paging Generated example
exp:expuserpending bin/php/expuserpending.php List the registrations that wait: for the e-mail address to be confirmed, for an administrator, or for an approval item, newest first Generated example
exp:expuserrequirepasswordchange bin/php/expuserrequirepasswordchange.php Require a new password at the account's next sign-in, or remove that mark with --clear, as the account's edit form does (a dry run unless --apply) Generated example
exp:expuserresendactivation bin/php/expuserresendactivation.php Send the activation mail again, with a new key, to an account that never activated, as Users > Unactivated does (a dry run unless --apply) Generated example
exp:expuserresetpassword bin/php/expuserresetpassword.php Reset a user's password: send the "reset your password" link, set a generated password shown once, or one read from standard input; optionally require a new password at the next sign-in (a dry run unless --apply) Generated example
exp:expuserroles bin/php/expuserroles.php Role assignments: list those of a user or group, assign a role with or without a subtree or section limitation, unassign it, as role/assign does (changes are a dry run unless --apply) Generated example
exp:expusersessions bin/php/expusersessions.php The tracked sessions of an account (Your devices): list them, end all of them or one, as an administrator does on user/sessions (ending is a dry run unless --apply) Generated example
exp:expusershow bin/php/expusershow.php Show one user account: groups, roles with their limitation, enabled or locked, last visit, registration state, two-step sign-in and active sessions (never a password hash) Generated example
exp:expuserunlock bin/php/expuserunlock.php Unlock an account locked after too many wrong passwords: its failed sign-ins back to 0, as Users > Hygiene does (a dry run unless --apply) Generated example
exp:expuserwhoami bin/php/expuserwhoami.php Which account the console acts as (the user of [UserSettings] UserCreatorID, or --as), with its roles and whether it has every right Generated example
exp:expviewcountupdate bin/php/expviewcountupdate.php Count the page views of the web server's access logs into the view counter (ezview_counter), for one siteaccess or several Generated example
exp:expwtmigratefromezwt bin/php/expwtmigratefromezwt.php Replace ezwt (the website toolbar) by expwt (the website sidebar): settings, policies, activation, schedule (dry run unless --apply) Generated example
exp:ezapplytemplate bin/php/ezapplytemplate.php Apply the template blocks found in files and write the files back (exit code 0, 1 or 2) Generated example
exp:ezasynchronouspublisher bin/php/ezasynchronouspublisher.php   Generated example
exp:ezcheckphptag bin/php/ezcheckphptag.php Check files for characters before the PHP start tag or after the end tag Generated example
exp:ezchecktranslation bin/php/ezchecktranslation.php Show statistics for one translation, e.g. ezchecktranslation.php ita-IT Generated example
exp:ezcontentcache bin/php/ezcontentcache.php Clear content caches of given nodes or subtrees (--clear-node, --clear-subtree) Generated example
exp:ezconvert2isbn13 bin/php/ezconvert2isbn13.php Convert ISBN-10 numbers to ISBN-13 Generated example
exp:ezconvertdbcharset bin/php/ezconvertdbcharset.php Convert all Exponential database tables to use UTF-8 character set Generated example
exp:ezconvertmysqltabletype bin/php/ezconvertmysqltabletype.php Convert the tables of a MySQL database to another table type (--list, --newtype=TYPE) Generated example
exp:ezcreatedeactivatedusergroup bin/php/ezcreatedeactivatedusergroup.php   Generated example
exp:ezcsvexport bin/php/ezcsvexport.php Export the subtree below a node to one CSV file per content class (--storage-dir) Generated example
exp:ezcsvimport bin/php/ezcsvimport.php Import content objects of a class below a node from a CSV file (--class, --creator) Generated example
exp:ezexec bin/php/ezexec.php Run a PHP script with the Exponential bootstrap done: ezexec.php myscript.php Generated example
exp:ezflowupgrade bin/php/ezflowupgrade.php Upgrade the installed ezflow packages (--to-version, --package, --url) Generated example
exp:ezgeneratetranslationcache bin/php/ezgeneratetranslationcache.php Generate translation cache files (--ts-list limits it to the given translations) Generated example
exp:ezimportdbafile bin/php/ezimportdbafile.php Import the dba data of a datatype into the database (--datatype=ezisbn) Generated example
exp:ezpgenerateautoloads bin/php/ezpgenerateautoloads.php Generate the class autoload arrays: kernel (-k), kernel overrides (-o), extensions (-e) Generated example
exp:ezpublishingbenchmark bin/php/ezpublishingbenchmark.php Benchmark parallel publishing in concurrent batches (--batches-count, -l level) Generated example
exp:ezrequestrules bin/php/ezrequestrules.php List and check the request rules of a siteaccess and explain their decision for an address Generated example
exp:ezsessiongc bin/php/ezsessiongc.php Remove expired sessions as defined by site.ini [Session] SessionTimeout Generated example
exp:ezsqldiff bin/php/ezsqldiff.php Show the differences between two database schemas; the exit code tells if they differ Generated example
exp:ezsqldumpisbndata bin/php/ezsqldumpisbndata.php Dump the ISBN group and range tables as SQL to a file or standard output Generated example
exp:ezsqldumpschema bin/php/ezsqldumpschema.php Dump the database schema to a file or standard output (--type, --user) Generated example
exp:ezsqlinsertschema bin/php/ezsqlinsertschema.php Insert a database schema and data from a .dba file into a database (--type, --user) Generated example
exp:ezsubtreecopy bin/php/ezsubtreecopy.php Copy a content subtree to a new location (--src-node-id, --dst-node-id; dry run unless --apply) Generated example
exp:eztemplatecheck bin/php/eztemplatecheck.php Check the syntax of the templates of a siteaccess or of a design directory Generated example
exp:ezwebincommon bin/php/ezwebincommon.php Helper library of ezwebininstall and ezwebinupgrade, not meant to be run directly Generated example
exp:ezwebininstall bin/php/ezwebininstall.php Install the ezwebin site package and configure the site Generated example
exp:ezwebinupgrade bin/php/ezwebinupgrade.php Upgrade an existing ezwebin installation to the current package version (--to-version) Generated example
exp:flatten bin/php/flatten.php Remove unused data from the database: contentobject, contentclass, workflow, role or all Generated example
exp:frankenphp bin/php/frankenphp.php Control the FrankenPHP engine of the Exponential web server Generated example
exp:i18n bin/php/i18n.php The translation fallbacks: per locale the chain of translations it falls back to, and how much of the kernel and of each extension it shows translated; --check for CI Generated example
exp:ini bin/php/ini.php Read and change INI settings in every scope: get, set, add, rem, clear, toggle, copy, move, where, list, scopes Generated example
exp:install bin/php/install.php One-command installation, SQLite by default, no kickstart.ini needed (a dry run unless --apply) Generated example
exp:installcrontab bin/php/installcrontab.php Show, add or remove the cron job of the installation: the crontab lines that run its cronjob parts (--add and --remove: dry run unless --apply) Generated example
exp:kickstarter bin/php/kickstarter.php Kickstarter runner: "ini" writes kickstart.ini, "run" installs from it (a dry run unless --apply) Generated example
exp:mailbounces bin/php/mailbounces.php Read the bounce mailbox: hard bounces and spam complaints go on the suppression list (dry run unless --apply) Generated example
exp:mailconsent bin/php/mailconsent.php The consent log of the e-mail preferences: list, export as CSV, retention cleanup (dry run unless --apply) Generated example
exp:mailgate bin/php/mailgate.php Test the mail gate: who of the given addresses would get a mail of a category, and what the decorated mail looks like Generated example
exp:mailpreferences bin/php/mailpreferences.php Show and change the e-mail preferences of a user or an address: categories, master switch, frequency, export, erase Generated example
exp:mailstatus bin/php/mailstatus.php Show the e-mail preference system: tables, gate, footer, categories, suppression, consent log, the gate's last decisions and problems Generated example
exp:mailsuppression bin/php/mailsuppression.php The suppression list of the e-mail gate: list, check, add and lift entries (only hashes are stored) Generated example
exp:maintenance bin/php/maintenance.php Take the site offline for maintenance and back: on, off or status Generated example
exp:makestaticcache bin/php/makestaticcache.php Crawl the public siteaccesses and generate static pages (--site, --max-pages, --max-depth) Generated example
exp:notificationevents bin/php/notificationevents.php List the notification events, or remove the old ones (dry run unless --apply) Generated example
exp:notificationrun bin/php/notificationrun.php Run the notification filter: send the notifications of the pending events and the due digests (dry run unless --apply) Generated example
exp:notificationstatus bin/php/notificationstatus.php Show the notification system: pending events, digest items, subscriptions, the last runs and problems Generated example
exp:notificationsubscriptions bin/php/notificationsubscriptions.php List the subtree notification subscriptions per user and subtree, or remove those whose content is gone (dry run unless --apply) Generated example
exp:phar bin/php/phar.php Build and inspect the engine archive dist/engine.phar (verbs build, check, clean, info) Generated example
exp:preload bin/php/preload.php Warm the page caches of a site: request its section pages, then follow its links, and report the broken ones (dry run unless --apply) Generated example
exp:preloadjob bin/php/preloadjob.php   Generated example
exp:publish_content bin/php/publish_content.php Publish one queued object version (OBJECT_ID VERSION_ID); internal, used by the publisher Generated example
exp:resetuserpassword bin/php/resetuserpassword.php Reset a user password with admin authentication or root bypass. Generated example
exp:services bin/php/services.php Compile, list, show and check the kernel service container (verbs compile, list, show, check) Generated example
exp:setupfiles bin/php/setupfiles.php Copy .htaccess_root (or .htaccess_root_static) to .htaccess and config.php-RECOMMENDED to config.php, with a diff, a backup and --force for an existing file (dry run unless --apply) Generated example
exp:solr bin/php/solr.php Control the Solr search server, once it is installed and configured Generated example
exp:systeminfo bin/php/systeminfo.php The facts and health checks of Setup > System information, as text or JSON (--json, --sizes) Generated example
exp:trashpurge bin/php/trashpurge.php Permanently delete all objects in the trash (dry run unless --apply) Generated example
exp:updateniceurls bin/php/updateniceurls.php Import old URL aliases and update the URL aliases of all nodes (--update-nodes) Generated example
exp:updatesearchindex bin/php/updatesearchindex.php Reindex all content objects in the search engine Generated example
exp:upgrade bin/php/upgrade.php Upgrade the installation in one call: every stage in order (dry run unless --apply) Generated example
exp:upgradebackup bin/php/upgradebackup.php Upgrade backup: the backup exp:upgrade makes before it writes, on its own (database dump and settings overrides) Generated example
exp:upgradecaptions bin/php/upgradecaptions.php Upgrade captions: the safe points to roll back to (git_manager's and exp:upgrade's), checked with --verify, pruned with --prune Generated example
exp:upgradecode bin/php/upgradecode.php Upgrade stage 1, code: the git checkouts moved to the target release, fast-forward only, through git_manager (dry run unless --apply) Generated example
exp:upgradedatabase bin/php/upgradedatabase.php Upgrade stage 3, database: the schema and data steps on every engine (dry run unless --apply) Generated example
exp:upgradefinish bin/php/upgradefinish.php Upgrade stage 5, finish: deploy the changes (exp:velocity deploy --kernel) and check the site answers (dry run unless --apply) Generated example
exp:upgradelibraries bin/php/upgradelibraries.php Upgrade stage 2, libraries: Composer install from composer.lock (or update of named packages) with a security audit (dry run unless --apply) Generated example
exp:upgraderollback bin/php/upgraderollback.php Upgrade rollback: put the database, storage, settings, libraries and code back to a caption (dry run unless --apply) Generated example
exp:upgradescripts bin/php/upgradescripts.php Upgrade stage 4, scripts: the PHP upgrade steps, policies and repairs (dry run unless --apply) Generated example
exp:upgradestatus bin/php/upgradestatus.php Upgrade status: every upgrade step with its state (done, pending, not-needed, failed, unknown) Generated example
exp:upgradesteps bin/php/upgradesteps.php Upgrade steps: the registered steps with id, stage, version, engines and description Generated example
exp:upgradeverify bin/php/upgradeverify.php Upgrade verify: re-detect every step and report drift; --after: the full check after an upgrade (steps, smoke addresses, tests, error log, autoloads) Generated example
exp:userlogincheck bin/php/userlogincheck.php Unique logins: list the logins more than one user account has; --fix-index adds the unique index on ezuser.login once there are none Generated example
exp:userpasswordchangerequired bin/php/userpasswordchangerequired.php Change password at next sign-in: show, set or clear the mark of a user account Generated example
exp:velocity bin/php/velocity.php   Generated example
exp:velocity-router bin/php/velocity-router.php Router of PHP's built-in web server, as the php engine of exp:velocity runs it Generated example
exp:velocity-warmup bin/php/velocity-warmup.php Warm the Velocity parent process once, before it forks its workers Generated example
exp:verify_aliases bin/php/verify_aliases.php Check ezurlalias_ml consistency (--fix repairs safe issues, --sql shows the queries) Generated example
exp:warm bin/php/warm.php Request every published page so no visitor pays for a render (--limit, --concurrency) Generated example
exp:webserver bin/php/webserver.php Control the Exponential web server (php, frankenphp or qbix engines); what writes is a dry run unless --apply Generated example

Source

The descriptions are the @description lines of the scripts (kernel/private/classes/commands/<name>.php, or the script itself).

Added to the reference for Exponential 6.0.15.

In this section

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.