💻Application Commands
env:set
Set a .env
value. Specify the like
to update or insert like this:
app:publish
Copy the base .env
and generate a routes.php
file in the application's resources
directory.
Use the --force
flag to overwrite the files should they already exist.
streams:publish
Copy the configuration, language files, and views from the Streams Platform into resources/streams
so that you can modify them to override core and commit the changes safely to your version control.
Use the --force
flag to overwrite the files should they already exist.
build
Compile Streams models and signal to others components that the system is building.
refresh
Refreshes all caches and signals to other components to refresh as well.
Streams Commands
make:stream
Create a scaffold a new stream.
The stream
argument should be a plural slug identifier for the stream like books
or favorite_books
.
The addon
argument must be a unique module or extension identifier like a dot namespace
or slug
. The stream classes will be generated in the addon's src
directory.
The --namespace
option may be used to specify a namespace for the stream like --namespace=book_store
. The slug of the specified addon
will be used by default.
The addon must be created using make:addon prior to running this command.{.notice}
streams:index
Import searchable
stream entries into the search index.
Use the optional namespace
argument to index stream entries within that namespace only.
Use the optional stream
argument to target entries for a specific stream with the namespace
.
The --flush
flag may be used flush the search index before importing.
streams:compile
Compile the base generated models for all streams from their database values.
streams:cleanup
Safely deletes any "abandoned" or otherwise garbage streams, fields, and assignments that might present themselves during or after development.
streams:destroy
Destroy all streams, fields, and assignments within a given namespace
.
Addon Commands
make:addon
Create an addon with everything you need to start development.
The namespace
argument looks like {vendor}.{type}.{addon}
and specifies the addon's vendor
slug, the type
slug, and the addon
slug of the desired addon to create.
The vendor
slug should reflect you as an author. The vendor
slug used by the creators of the Streams Platform for example is anomaly
.
Supported type
slugs are module
, theme
, extension
, plugin
, and field_type
.
The addon
slug is the slug_formatted
name of the addon you are creating.
addon:install
Install an addon.
The required addon
argument must be an addon identifier like anomaly.module.store
.
The --seed
flag causes the addon to be seeded as well.
Only modules and extensions are installable.{.notice}
addon:uninstall
Uninstall an addon.
The required addon
argument must be an addon identifier like anomaly.module.store
.
Only modules and extensions are installable.{.notice}
addon:reinstall
Reinstall an addon.
The required addon
argument must be an addon identifier like anomaly.module.store
.
Only modules and extensions are installable.{.notice}
addon:publish
Copy the configuration, language files, and views from the specified addon
into resources/streams
so that you can modify them to override the addon and commit the changes safely to your version control.
The required addon
argument must be an addon identifier like anomaly.module.store
.
Use the --force
flag to overwrite the files should they already exist.
Last updated