This repository has been archived by the owner on Apr 16, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
59 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,45 @@ | ||
# Lucid • Console | ||
The Console companion for the Lucid Architecture. | ||
|
||
## Command Line Interface | ||
The console ships with a command line interface called `lucid` that you can find in `vendor/bin/lucid` and use as | ||
``` | ||
lucid make:feature ListUsers Api | ||
``` | ||
|
||
> To be able to address the `lucid` cli directly you need to have `./vendor/bin` as part of your `$PATH`. | ||
To do that, put this in your shell profile (~/.bash_profile, ~/.zshrc, ~/bashrc) `export PATH="$PATH:./vendor/bin`" | ||
|
||
### Available Commands | ||
|
||
- `help` Displays help for a command | ||
- `list` Lists commands | ||
- **make** | ||
- `make:controller` Create a new resource Controller class in a service | ||
- `make:feature ` Create a new Feature in a service | ||
- `make:job ` Create a new Job in a domain | ||
- `make:service ` Create a new Service | ||
- **list** | ||
- `list:features` List the features. | ||
- `list:services` List the services in this project. | ||
- **delete** | ||
- `delete:feature` Delete an existing Feature in a service | ||
- `delete:job ` Delete an existing Job in a domain | ||
- `delete:service` Delete an existing Service | ||
|
||
### Commands Usage | ||
|
||
#### Make | ||
- `make:controller <controller> [<service>]` | ||
- `make:feature <feature> [<service>]` | ||
- `make:job <job> <domain>` | ||
- `make:service <name>` | ||
|
||
#### List | ||
- `list:services` | ||
- `list:features [<service>]` | ||
|
||
#### Delete | ||
- `delete:service <name>` | ||
- `delete:feature <feature> [<service>]` | ||
- `delete:job <job> <domain>` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters