studioespresso / craft-seeder
Easy entries seeder for Craft CMS
Installs: 17 063
Dependents: 0
Suggesters: 0
Security: 0
Stars: 30
Watchers: 3
Forks: 2
Open Issues: 7
Type:craft-plugin
Requires
- craftcms/cms: ^3.1.0
- fzaninotto/faker: ^1.7.0
Requires (Dev)
- codeception/codeception: 2.4.2
README
Usage
Seeder allows you to quickly create dummy entries through the command line. And you can just as easily remove the dummy data when you're done building the site.
With the plugin installed, running ./craft help seeder/generate will show you which commands are available
Since the plugin is only usefull during the development and not on a live site, charging money for it would be stupid (you could just free trial it every time). Instead you can download it for free and if you want to support future development, you can support it on beerpay.io. Thanks!
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project -
Then tell Composer to load the plugin:
composer require studioespresso/craft-seeder -
In the Control Panel, go to Settings → Plugins and click the “Install” button for "Seeder".
Usage
Entries (Section ID/handle, siteId, count)
Use the command below, followed by the --section option and the --number of entries you want to create (defaults to 20 if ommited). This command works with both section ID and handle.
You can also add a siteId parameter to seed entries for a specific site. This will use the default site as a fallback.
./craft seeder/generate/entries --section=news --count=15
Categories (Category group ID/handle, count)
./craft seeder/generate/categories --group=labels --count=10
Users (Usergroup ID/handle, count)
./craft seeder/generate/users --group=editors --count=5
Clean up
Once you're done building out the site, the plugin gives you an easy way to remove the dummy data (entries, assets, categories and users). This can be done through the CP (click the Seeder section the sidebar) or through the command line with the following command:
./craft seeder/clean-up/all
Configuration options
eachMatrixBlock - Seed all blocktypes in a matrix field
For a matrix, the plugin will get a random set of block types within the minimum & maximum amounts of blocks the field allows.
With this setting set to true, we'll generate a block of each blocktype once in a random order. This is a good way to test pagebuilder/contentbuilder-like fields.
useLocalAssets - Use assets already in your site to seed asset fields
'useLocalAssets' => [ 'volumeId' => 1, 'path' => 'test/' ]
Add the array above to config/seeder.php to seed using assets from volume 1 and folder test/.
fields - Basic field configuration
'fields' => [ "sessions" => "ignore", "radioField" => [ 'value' => 'value2', ], "category" => [ 'mode' => 'random', 'value' => [152, 153] ] ]
These are some basic examples of how you can defined seeding settings per field. The field handle should be the key in the array and the options are available right now:
- "ignore" => skip the field when seeding
["value" => "some string" ]=> Works to set a fixed value for plain text fields, checkboxes, radio buttons.["mode" => "random", "value" => [1, 2] ]=> Works with entries and category fields, values should be ids of those entries.
Troubleshooting
The most common problem with the plugins is getting the following error:
Unknown command: seeder/generate/entries
If you have the plugin installed in the CP and are seeing this message, craft can not connect to your database through the command line. Your site probably works correctly but CLI commands won't.
If you're running MAMP/XAMP, you should use 127.0.0.1 as hostname instead of localhost.
Roadmap
Core elements
- Entries
- Categories
- Users
- Entry fields
Core fields
- Title
- Plain text
- Url
- Color
- Date
- Entries
- Categories
- Dropdown
- Checkboxes
- Radio buttons
- Multi select
- Assets
- Matrix
- Lightswitch
- Table
- Tags
- Users
Plugin elements
- Commerce products & variants