Skip to content
This repository was archived by the owner on Mar 20, 2025. It is now read-only.

Commit fb374e1

Browse files
committed
Add badges
1 parent 66171ca commit fb374e1

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1+
<p style="text-align: right;">
2+
<a href="https://github.com/laravel-shift/blueprint/actions"><img src="https://github.com/laravel-shift/cli/workflows/Build/badge.svg" alt="Build Status"></a>
3+
<a href="https://packagist.org/packages/laravel-shift/cli"><img src="https://poser.pugx.org/laravel-shift/cli/v/stable.svg" alt="Latest Stable Version"></a>
4+
<a href="https://github.com/badges/poser/blob/master/LICENSE"><img src="https://poser.pugx.org/laravel-shift/cli/license.svg" alt="License"></a>
5+
</p>
6+
17
# Shift CLI
2-
A tool by [Shift](https://laravelshift.com/) to run automated tasks for maintaining your Laravel projects. With this tool, you may also create your own automated tasks and easily share them.
8+
A tool by [Shift](https://laravelshift.com/) to run automated tasks for refactoring and modernizing your Laravel projects.
39

4-
The Shift CLI replaces the [Shift Workbench](https://laravelshift.com/workbench) desktop app -- allowing you to run the same tasks conveniently in your local PHP environment. No Electron. No Docker. Similar to the Workbench, the free tasks are available to run immediately. Premium tasks are available with [a license](https://laravelshift.com/cli#licenses).
10+
The Shift CLI replaces the [Shift Workbench](https://laravelshift.com/workbench) desktop app - allowing you to run the same tasks conveniently in your local PHP environment. No Electron. No Docker. Similar to the Workbench, the free tasks are available to run immediately. Premium tasks are available with [a license](https://laravelshift.com/cli#licenses).
511

612

713
## Installation
@@ -80,25 +86,26 @@ Taking this farther, you may automate this by setting up your own Composer scrip
8086
}
8187
```
8288

83-
Then run: `composer lint`
89+
You may optimize this script by passing the `--dirty` option to both the Shift CLI and Pint. Once you have added this script, you may run: `composer lint`
8490

85-
You may optimize this script by passing the `--dirty` option to both the Shift CLI and Pint. Additionally, you may add the `shift-cli` command to a pre-commit hook to ensure the automation is always run before making a commit.
91+
Additionally, you may add the `shift-cli` command to a pre-commit hook to ensure the automation is always run before making a commit.
8692

87-
Finally, you are encouraged to add the `shift-cli` to your CI workflows as well. For example, running the automation on every Pull Request to ensure all merged code consistently follows Laravel conventions.
93+
Finally, you are encouraged to add the `shift-cli` to your CI workflows. For example, you may run the `shift-cli` as part of every Pull Request to ensure all merged code consistently follows Laravel conventions.
8894

8995
Examples of setting up Composer scripts and pre-commit hooks may be found in the [Shift CreatorSeries on Laracasts](https://laracasts.com/series/automated-laravel-upgrades/episodes/4).
9096

9197

9298
## Additional Commands
9399
The Shift CLI comes with two additional commands: `publish` and `discover`.
94100

95-
The `publish` command generates a Shift CLI config file - `shift-cli.json`. The generated configuration file includes all of the defaults. You may customize the configuration file to specify which tasks to run by default, additional paths to ignore, and options for individual tasks.
101+
The `publish` command generates a Shift CLI configuration file - `shift-cli.json`. The generated configuration file includes all of the defaults. You may customize the configuration file to specify which tasks to run by default, additional paths to ignore, and options for individual tasks.
96102

97-
The `discover` command regenerates the Shift CLI task registry. This is done automatically anytime the Shift CLI is updated. However, you may need to run this command if you have included other packages which provide Shift CLI tasks.
103+
The `discover` command regenerates the Shift CLI task manifest. This is done automatically anytime the Shift CLI is updated. However, you may need to run this command if you have included other packages which provide Shift CLI tasks.
98104

99105

100106
## Support Policy
101107
The automated tasks within the Shift CLI prioritize the latest stable version of Laravel (currently Laravel 10). While there will be a grace period when new versions of Laravel are released, you are encouraged to keep your application upgraded (try using [Shift](https://laravelshift.com)).
102108

109+
103110
## Contributing
104111
Contributions are welcome in the form of opening an issue or submitting a pull request. For issues to be considered, they should follow one of the templates. For PRs to be considered, they should have tests and all checks should pass.

0 commit comments

Comments
 (0)