Skip to content

Commit 9b4f559

Browse files
Add additional console commands to Readme (#83)
1 parent 318ffac commit 9b4f559

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Watch a quick [demo of Blueprint](https://www.youtube.com/watch?v=A_gUCwni_6c) i
88
- [Requirements](#requirements)
99
- [Basic Usage](#basic-usage)
1010
- [Defining Components](#defining-components)
11+
- [Additional Console Commands](#additional-console-commands)
1112
- [Contributing](#contributing)
1213

1314

@@ -26,7 +27,7 @@ Blueprint requires a Laravel application running version 6.0 or higher.
2627
While Blueprint may be more flexible in a future version, it currently assumes a standard project structure using the default `App` namespace.
2728

2829
## Basic Usage
29-
Blueprint adds an artisan command.
30+
Blueprint adds multiple artisan commands. The most commonly used command is the `blueprint:build` command to generate the Laravel components:
3031

3132
```sh
3233
php artisan blueprint:build [draft]
@@ -313,6 +314,23 @@ controllers:
313314

314315
While these references will often be used within _Eloquent_ and `query` statements, they may be used in other statements as well. When necessary, Blueprint will convert these into variable references using an arrow (`->`) syntax.
315316

317+
## Additional Console Commands
318+
Beyond the `blueprint:build` command, Blueprint provides additional commands:
319+
320+
<dl>
321+
<dt>blueprint:erase</dt>
322+
<dd>
323+
324+
Erases the components created by the last _build_ and warns about any updated components.
325+
326+
While this command is helpful, it's better to run the `blueprint:build` command from a clean working state and use Git commands like `reset` and `clean` to _undo_ the last _build_.</dd>
327+
<dt>blueprint:trace</dt>
328+
<dd>
329+
330+
Loads definitions for existing models into the Blueprint cache file (`.blueprint`) so you may reference them in your _draft_ file.</dd>
331+
</dl>
332+
333+
316334
## Contributing
317335
Contributions may be made by submitting a Pull Request against the `master` branch. Any submissions should be complete with tests and adhere to the [PSR-2 code style](https://www.php-fig.org/psr/psr-2/).
318336

0 commit comments

Comments
 (0)