Skip to content
This repository was archived by the owner on Apr 16, 2024. It is now read-only.

Commit 64baa7e

Browse files
committed
add commands docs
1 parent 47a2b5a commit 64baa7e

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,44 @@
11
The Console companion for the Lucid Architecture.
2+
3+
## Command Line Interface
4+
The console ships with a command line interface called `lucid` that you can find in `vendor/bin/lucid` and use as
5+
```
6+
lucid make:feature ListUsers Api
7+
```
8+
9+
> To be able to address the `lucid` cli directly you need to have `./vendor/bin` as part of your `$PATH`.
10+
To do that, put this in your shell profile (~/.bash_profile, ~/.zshrc, ~/bashrc) `export PATH="$PATH:./vendor/bin`"
11+
12+
### Available Commands
13+
14+
- `help` Displays help for a command
15+
- `list` Lists commands
16+
- **make**
17+
- `make:controller` Create a new resource Controller class in a service
18+
- `make:feature ` Create a new Feature in a service
19+
- `make:job ` Create a new Job in a domain
20+
- `make:service ` Create a new Service
21+
- **list**
22+
- `list:features` List the features.
23+
- `list:services` List the services in this project.
24+
- **delete**
25+
- `delete:feature` Delete an existing Feature in a service
26+
- `delete:job ` Delete an existing Job in a domain
27+
- `delete:service` Delete an existing Service
28+
29+
### Commands Usage
30+
31+
#### Make
32+
- `make:controller <controller> [<service>]`
33+
- `make:feature <feature> [<service>]`
34+
- `make:job <job> <domain>`
35+
- `make:service <name>`
36+
37+
#### List
38+
- `list:services`
39+
- `list:features [<service>]`
40+
41+
#### Delete
42+
- `delete:service <name>`
43+
- `delete:feature <feature> [<service>]`
44+
- `delete:job <job> <domain>`

0 commit comments

Comments
 (0)