When should I use events instead of a build step?
Unlike build steps
events will run every time so it is advisable to use them for automating common steps like compiling
sass before or after your app starts and not installing lower level dependencies like
node modules or
Events allow you to automate commands or tasks you might often or always run either
after something happens. Generally you can hook into
post events for every part of the Lando and App runtime. At time of writing those events were:
You can also hook into
post events for all tooling commands. For example, the command
lando db-import should expose
While the above lists are great starting point they may be out of date. You can explicitly discover what events are available by running:
# Discover hookable events for the `lando start` command lando start -vvv | grep "Emitting" # Discover hookable events for the `lando test` command # NOTE: This assumed you've defined a `test` command in tooling lando test -vvv | grep "Emitting"
Specifically, you need to hook into an event where the service you are running the command against exists and is running.
It's fairly straightforward to add events to your Landofile using the
events top level config.
Note that due to the nature of events, eg. automating steps that the user usually runs, all commands are run as "you" and do not have
By default, event commands will run on the
appserver service which may not exist if you are not using one of Lando's recipes as a starting point for your Landofile.
events: pre-start: - yarn install - echo "I JUST YARNED"
An exception for this is events that are based on tooling commands which will use the tooling
service as the default.
events: post-thing: - some-command tooling: thing: service: web
In the above scenario,
some-command will run on the
web service by default instead of the
appserver. For dynamic tooling routes events will use the default of the dynamic route.
events: post-dynamic: - some-command tooling dynamic: cmd: env service: :host options: host: default: web2 alias: - h describe: Run a different service
In the above scenario,
some-command will run on
web2 by default.
While the defaults above are good to know we highly recommend you just explicitly define which commands should run on which services by keying the command with a service as below.
events: pre-start: - appserver: composer install - database: echo "I JUST COMPOSERED" post-start: - node: yarn sass - appserver: composer compile-templates