Skip to content

Commit e622082

Browse files
committed
📝 Add CLI options
1 parent 8b5d1a2 commit e622082

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,27 @@ Run directly from GitHub repo via npx:
2121
Usage: npm exec --ignore-scripts -- github:AckeeCZ/create-node-app [OPTIONS]
2222
2323
Options:
24-
--dir, -d PATH Specifies directory path for app (default: node-app)
25-
--project-name, -n NAME Google Cloud project name (default: same as directory)
26-
--force, -f Overwrite existing destination directory if it's not empty
27-
--debug -D Enables debug logging
28-
--help, -h Show this help message
24+
-d, --dir Destination directory [string] [default: "./node-app"]
25+
-D, --debug Enables debug logs [boolean] [default: false]
26+
-n, --project-name Google Cloud project name [string] [default: "node-app"]
27+
-f, --force Overwrite existing destination if it's not empty
28+
[boolean] [default: false]
29+
--api Selects API
30+
[string] [choices: "graphql", "rest"]
31+
--database Selects database as database
32+
[string] [choices: "postgres-knex"]
33+
--pipeline Selects pipeline
34+
[string] [choices: "cloudrun-gitlab"]
35+
--version Show version number [boolean]
36+
--help Show help [boolean]
2937
```
3038

3139
## Setup options
3240

3341
- API layer
3442
- [RESTful](starter/api/rest/)
3543
- [GraphQL](starter/api/graphql/)
36-
- Infrastructure
44+
- Database
3745
- [PostgreSQL](starter/infra/postgresql-knex/) using [Knex](https://github.com/knex/knex)
3846
- Pipelines
3947
- [GitLab CloudRun](starter/pipeline/cloudrun-gitlab/)

0 commit comments

Comments
 (0)