{"id":16458742,"url":"https://github.com/sebbaum/laravel-artisan","last_synced_at":"2025-10-23T19:48:35.239Z","repository":{"id":90673402,"uuid":"103491448","full_name":"sebbaum/laravel-artisan","owner":"sebbaum","description":"Chef cookbook to run laravel's artisan commands on remote nodes","archived":false,"fork":false,"pushed_at":"2021-03-05T12:48:25.000Z","size":54,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T12:51:13.861Z","etag":null,"topics":["artisan","artisan-command","chef","chef-cookbook","laravel","opsworks"],"latest_commit_sha":null,"homepage":"http://www.sebbaum.de","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sebbaum.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-14T05:53:31.000Z","updated_at":"2022-01-05T04:02:22.000Z","dependencies_parsed_at":"2023-07-09T05:03:07.521Z","dependency_job_id":null,"html_url":"https://github.com/sebbaum/laravel-artisan","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebbaum%2Flaravel-artisan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebbaum%2Flaravel-artisan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebbaum%2Flaravel-artisan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebbaum%2Flaravel-artisan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sebbaum","download_url":"https://codeload.github.com/sebbaum/laravel-artisan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251432574,"owners_count":21588606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["artisan","artisan-command","chef","chef-cookbook","laravel","opsworks"],"created_at":"2024-10-11T10:46:11.454Z","updated_at":"2025-10-23T19:48:30.199Z","avatar_url":"https://github.com/sebbaum.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Laravel-Artisan Cookbook\n\n[![Cookbook Version](https://img.shields.io/cookbook/v/laravel-artisan.svg)](https://supermarket.chef.io/cookbooks/laravel-artisan) [![Github Release](https://img.shields.io/github/release/sebbaum/laravel-artisan.svg)](https://github.com/sebbaum/laravel-artisan/releases) [![Github Issues](https://img.shields.io/github/issues/sebbaum/laravel-artisan.svg)](https://github.com/sebbaum/laravel-artisan/issues) [![license](https://img.shields.io/github/license/sebbaum/laravel-artisan.svg)](https://github.com/sebbaum/laravel-artisan/blob/master/LICENSE)\n\nDid you ever want to run [Laravel's php artisan commands](https://laravel.com/docs/5.5/artisan) on an automated infrastructure? If you are using [Chef](https://www.chef.io/) then this cookbook is for you.\n\n## Scope\nThis cookbook supports some of the artisan commands, that are useful on a load balanced server infrastructure.  \nCommands that are particular useful for development are not supported.\n\n### Supported commands:\n* clear-compiled\n* down\n* env\n* up\n* cache:clear\n* config:cache\n* config:clear\n* migrate:status\n* package:discover\n* queue:work\n* route:cache\n* route:clear\n* schedule:run\n* view:clear\n\n## Requirements\n* Chef 12.7 or higher\n\n## Platform Support\nThis cookbook has been developed and used on Ubuntu 16.04.\n\n## Environment Support\nSupported Environments:\n* Vagrant\n* AWS Opsworks\n\n## Cookbook Dependencies\nCurrently none.\n\n## Usage\nPlace a dependency on the laravel-artisan cookbook in your cookbook's metadata.rb\n\n```ruby\ndepends 'laravel-artisan'\n```\n\nor add the dependency in your Berksfile:  \n```ruby\ncookbook 'laravel-artisan'\n```\n\nThen, you can run the recipes using Chef's runlist. Right away this will throw an Exception. To get it work properly you have\nto pass a path to the directory where the `artisan` file is located.\n\n### Envirionment file\nPassing the path to the artisan file via an environment file:\n```json\n{\n  \"name\": \"development\",\n  \"description\": \"Vagrant Development Environment\",\n  \"default_attributes\": {\n    \"laravel-artisan\": {\n      \"path\": \"\u003cpath-to-artisan-file\u003e\"\n    }\n  },\n  \"json_class\": \"Chef::Environment\",\n  \"chef_type\": \"environment\"\n}\n```\n\n### AWS Opsworks\nUsing AWS Opsworks you can pass in the path via custom json:\n```json\n{\n  \"laravel-artisan\": {\n    \"path\": \"\u003cpath-to-artisan-file\u003e\"\n  }\n}\n```\n\n## Recipes\n* `laravel-artisan::clear-compiled`\t  -\tRemove the compiled class file\n* `laravel-artisan::down` \t\t\t\t    - Put the application into maintenance mode.\n* `laravel-artisan::env`\t\t\t\t      - Display the current framework environment.\n* `laravel-aritsan::up` \t\t\t\t      - Bring the application out of maintenance mode.\n* `laravel-artisan::cache_clear`\t\t  - Flush the application cache.\n* `laravel-artisan::config_cache`\t\t  - Create a cache file for faster configuration loading.\n* `laravel-artisan::config_clear`\t\t  - Remove the configuaration cache file.\n* `laravel-artisan::migrate_status`   - Show the status of each migration.\n* `laravel-artisan::package_discover` -\tRebuild the cached package manifest.\n* `laravel-artisan::queue_work`       - Start processing jobs on the queue as a daemon.\n* `laravel-artisan::queue_stop`       - Stop processing jobs on the queue as a daemon.\n* `laravel-artisan::route_cache`      - Create a route cache file for faster route registration\n* `laravel-artisan::route_clear`      - Remove the route cache file.\n* `laravel-artisan::schedule_run`\t\t  - Run the scheduled commands.\n* `laravel-artisan::schedule_stop`    -\tRemove the cronjob that runs `php artisan schedule:run`\n* `laravel-artisan::view_clear`\t\t\t  - Clear all compiled view files.\n\n## Resources\n\n### artisan\nUse this resource to run artisan cammands in other cookbooks.\n\n#### Actions\n* `run` - Run an artisan command\n\n#### Properties\n* `path` - (required) Path where the artisan file is located.\n* `command` - (optional) Artisan command that should be run. By default it's assumed that the name of the artisan resource is the command, but this allows overriding that.\n* `check` - (optional) By default it is checked, that there is an artisan file at the given `path`. However this check can be disabled.\n* `verbosity` - (optional) Configure how verbos the artisan command should be. Default is '-v'.\n\n### artisan_schedule\n\n#### Actions\n* `create` - Create a cron entry to run the artisan schedule:run command.\n* `remove` - Remove the cron entry to stop the artisan schedule:run command.\n\n#### Properties\n* `path` - (required) Path where the artisan file is located.\n* `command` - (optional) Artisan command that should be run. By default it's assumed that the name of the artisan resource is the command, but this allows overriding that.\n* `check` - (optional) By default it is checked, that there is an artisan file at the given `path`. However this check can be disabled.\n* `verbosity` - (optional) Configure how verbos the artisan command should be. Default is '-v'.\n* `user` - (optional) Choose the crontab of a user, who should run the command.\n\n### artisan_queue\n\n#### Actions\n* `start` - Install supervisor and add a configuration that enables a supervised artisan queue:work command.\n* `stop` - Stops the supervised artisan queue:work command.\n\n#### Properties\n* `worker_name` - (required) Name of the supervisor worker process\n* `path` - (required) Path where the artisan file is located.\n* `configuration` - (required) A Hash that contains the configuration for the supervisor configuration file.\n* `conf_dir` - (optional) Directory where supervisor conf files are located. By default this is: `'/etc/supervisor/conf.d'`.\n* `check` - (optional) By default it is checked, that there is an artisan file at the given `path`. However this check can be disabled.\n* `verbosity` - (optional) Configure how verbos the artisan command should be. Default is '-v'.\n* `owner`- (optional) Owner of the configuration file. By default this is `'root'`.\n* `group`- (optional) Group of the configuration file. By default this is `'root'`.\n* `mode`- (optional) Mode of the configuration file. By default this is `'0644'`.\n\n\n## Authors\n\nAuthor: [Sebastian Baum](https://github.com/sebbaum) \u0026 [Contributors](https://github.com/sebbaum/laravel-artisan/graphs/contributors)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsebbaum%2Flaravel-artisan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsebbaum%2Flaravel-artisan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsebbaum%2Flaravel-artisan/lists"}