{"id":19490178,"url":"https://github.com/silverleague/silverstripe-console","last_synced_at":"2025-04-25T19:31:09.802Z","repository":{"id":57050793,"uuid":"77868192","full_name":"silverleague/silverstripe-console","owner":"silverleague","description":"A better CLI console for SilverStripe applications","archived":false,"fork":false,"pushed_at":"2019-05-07T02:23:59.000Z","size":425,"stargazers_count":9,"open_issues_count":7,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-17T00:19:23.248Z","etag":null,"topics":["cli","console","silverleague-modules","silverstripe","silverstripe-4"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/silverleague.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-02T23:21:53.000Z","updated_at":"2022-01-10T00:42:34.000Z","dependencies_parsed_at":"2022-08-24T03:40:57.125Z","dependency_job_id":null,"html_url":"https://github.com/silverleague/silverstripe-console","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverleague%2Fsilverstripe-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverleague%2Fsilverstripe-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverleague%2Fsilverstripe-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverleague%2Fsilverstripe-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silverleague","download_url":"https://codeload.github.com/silverleague/silverstripe-console/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224014258,"owners_count":17241281,"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":["cli","console","silverleague-modules","silverstripe","silverstripe-4"],"created_at":"2024-11-10T21:11:39.307Z","updated_at":"2024-11-10T21:11:40.235Z","avatar_url":"https://github.com/silverleague.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# silverleague/ssconsole\n\n[![Travis](https://img.shields.io/travis/silverleague/silverstripe-console.svg)](https://travis-ci.org/silverleague/silverstripe-console) [![Scrutinizer](https://img.shields.io/scrutinizer/g/silverleague/silverstripe-console.svg)](https://scrutinizer-ci.com/g/silverleague/silverstripe-console/) [![Code coverage](https://codecov.io/gh/silverleague/silverstripe-console/branch/master/graph/badge.svg)](https://codecov.io/gh/silverleague/silverstripe-console)\n\nA useful command line interface for SilverStripe developers.\n\n![Screenshot](docs/images/console-screenshot.png)\n\n## Requirements\n\n* PHP 5.6 or above\n* SilverStripe 4.x or above\n* Composer\n\n## Installation\n\n### With Composer\n\nIt is recommended to install this module globally with composer:\n\n```shell\ncomposer global require silverleague/ssconsole\n$ ssconsole\n```\n\nEnsure your composer's `bin` folder has been added to your system path.\n\nYou can still require this module as a project dependency if you don't want to install it globally, of course:\n\n```shell\ncomposer require --dev silverleague/ssconsole\n$ vendor/bin/ssconsole\n```\n\n### From source\n\nIf you wish to install this module from source, you can clone the repository and symlink `bin/ssconsole` into your system path, for example:\n\n```bash\ngit clone git@github.com:silverleague/silverstripe-console.git\ncd silverstripe-console\nchmod u+x bin/console\nln -s \"$(pwd)/bin/ssconsole\" /usr/local/bin/ssconsole\n```\n\n## Usage\n\nFor detailed usage information, please [see the documentation](docs/en).\n\n### Commands\n\nTo show the console menu and list of commands, run `ssconsole` from your terminal.\n\n### Running commands\n\nTo run a command, choose the desired command from the menu and add it as an argument:\n\n```shell\n# Runs a task\nssconsole dev:tasks:cleanup-test-databases\n\n# Builds the database and flushed the manifest/cache\nssconsole dev:build --flush\n```\n\n### Flushing the manifest\n\nSometimes you need to flush SilverStripe's manifest/cache while running CLI tasks. For example, if you've added a new `BuildTask`, but it doesn't show up in the SilverStripe console yet.\n\nYou can add the `--flush` option to any `ssconsole` command to instruct SilverStripe to flush and rebuild its manifest.\n\n## Support\n\nIf you encounter a problem with our module then please let us know by raising an issue on our [issue tracker](https://github.com/silverleague/silverstripe-console/issues).\n\nEnsure you tell us which version of this module you are using, as well as which versions of PHP and SilverStripe framework you are using. If you aren't sure, you can find out by running the following commands from your command line: `php -v`, `composer [global] show silverleague/ssconsole` and `composer show silverstripe/framework`.\n\n## Roles\n\n| Role          | Name                                              |\n| ------------- | ------------------------------------------------- |\n| Maintainer    | [robbieaverill](https://github.com/robbieaverill) |\n| Co-maintainer | [robingram](https://github.com/robingram)         |\n| Advocate      | [dmc-core](https://github.com/dmc-core)           |\n\n## Contributing\n\nPlease see [the contributing guide](CONTRIBUTING.md) for more information.\n\n## License\n\nThis module is licensed under the [MIT license](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilverleague%2Fsilverstripe-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilverleague%2Fsilverstripe-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilverleague%2Fsilverstripe-console/lists"}