Lightna Lane is almost there! Read more | Lightna release is coming! Keep me updated
|||
🚧 Documentation in Progress 🚧
This documentation is actively being written and updated daily. Some sections may change or expand as we improve it.
If you have any questions or suggestions, feel free to reach out .
Content

CLI Commands

Make
make self-update Update Lightna packages.
make install Install Composer and Node dependencies as defined in the lock files.
make compile Apply changes to the current build, except CSS, JS, and assets.
make compile-i Executes make compile followed by make index.update.
make build Regenerate the build.
make index.update Update all indices.
make schema.update Update storage schemas.
make sync Syncs the environment by running make install then make build then make schema.update — useful after pulling new changes.
make sync-i Executes make sync followed by make index.update.
make config.apply Apply changes from config.php and env.php. Not needed when using make compile or make build.
make test.unit Execute unit tests.
make test.integration Execute integration tests.
make watch.main.js Watch for changes in the main edition JavaScript.
make watch.main.common.css Watch for changes in the main edition common.css.
make build.update Update the existing build, useful when debugging.
./cli
./cli Displays a list of all available commands
./cli config <config_key> Show the configuration value for the specified key. If no key is provided, print the entire configuration in JSON format.
./cli index.entity.invalidate <entity_name> [...] Invalidate the specified index by name. The invalidated index will be updated in the background.
./cli index.entity.list List all index entities.
./cli index.entity.show <entity_name> <entity_id> [--scope=<scope_id>] Print the entity from the index in JSON format.
./cli index.gc Clean the index in cases such as index version rotation, restoring after crashes, or changing index-related configurations.
./cli index.queue.block Block the index queue processing to control multi-process reindexing or during an index version change.
./cli index.queue.process Process the index changelog and queue.
./cli index.queue.reset Truncate the index changelog and queue.
./cli index.queue.unblock Unblock the index queue processing.
./cli index.queue.watch Watch the index queue within the current minute and process immediately.
./cli index.update.all [--next-version] Update all indices. Use --next-version to create a new index version.
./cli index.update.entity <entity_name> [...] [--scope=<scope_id>] [--multi] Update the index for specified entities. If a scope is specified, only that scope will be updated. Use --multi for multi-process reindexing.
./cli index.update.storage <storage_name> [...] Update the index for the specified storages.
./cli index.version.bind Instruct Lightna to bind the current index version to the current build. When the build changes, Lightna will switch to the next index version.
./cli index.version.down Move the index to the previous version.
./cli index.version.up Move the index to the next version.
./cli session.version.up Increment the session version, ensuring session data is refreshed on the next request.

⚙️  Documentation Review

Noticed an issue or need more details? Submit your feedback for this page.
Leave a Feedback