Skip to content

Commit 133c9e0

Browse files
authored
docs: Replace cubejs with npx cubejs-cli (#6430)
1 parent ab29d8b commit 133c9e0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/content/Reference/CLI/CLI-Reference.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `create` command generates barebones Cube app.
1313
### <--{"id" : "create"}--> Usage
1414

1515
```bash{promptUser: user}
16-
cubejs create APP-NAME -d DB-TYPE [-t TEMPLATE]
16+
npx cubejs-cli create APP-NAME -d DB-TYPE [-t TEMPLATE]
1717
```
1818

1919
### <--{"id" : "create"}--> Flags
@@ -29,13 +29,13 @@ Create app called `demo-app` using default (`docker`) template and `mysql`
2929
database:
3030

3131
```bash{promptUser: user}
32-
cubejs create demo-app -d mysql
32+
npx cubejs-cli create demo-app -d mysql
3333
```
3434

3535
Create app called `demo-app` using `express` template and `mysql` database:
3636

3737
```bash{promptUser: user}
38-
cubejs create demo-app -t express -d mysql
38+
npx cubejs-cli create demo-app -t express -d mysql
3939
```
4040

4141
## server
@@ -52,19 +52,19 @@ The `server` command starts Cube in production mode.
5252
Default start:
5353

5454
```bash{promptUser: user}
55-
cubejs server
55+
npx cubejs-cli server
5656
```
5757

5858
With debug information:
5959

6060
```bash{promptUser: user}
61-
cubejs server --debug
61+
npx cubejs-cli server --debug
6262
```
6363

6464
### <--{"id" : "server"}--> Usage
6565

6666
```bash{promptUser: user}
67-
cubejs server
67+
npx cubejs-cli server
6868
```
6969

7070
## generate
@@ -76,7 +76,7 @@ an active [database connection](/config/databases).
7676
### <--{"id" : "generate"}--> Usage
7777

7878
```bash{promptUser: user}
79-
cubejs generate -t TABLE-NAMES
79+
npx cubejs-cli generate -t TABLE-NAMES
8080
```
8181

8282
### <--{"id" : "generate"}--> Flags
@@ -90,7 +90,7 @@ cubejs generate -t TABLE-NAMES
9090
Generate schema files for tables `orders` and `customers`:
9191

9292
```bash{promptUser: user}
93-
cubejs generate -t orders,customers
93+
npx cubejs-cli generate -t orders,customers
9494
```
9595

9696
## token
@@ -106,7 +106,7 @@ security best practices._
106106
### <--{"id" : "token"}--> Usage
107107

108108
```bash{promptUser: user}
109-
cubejs token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR -u BAZ=QUX
109+
npx cubejs-cli token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR -u BAZ=QUX
110110
```
111111

112112
### <--{"id" : "token"}--> Flags
@@ -123,7 +123,7 @@ cubejs token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR -u BAZ=QUX
123123
Generate token with 1 day expiry and payload `{ 'appId': 1, 'userId': 2 }`:
124124

125125
```bash{promptUser: user}
126-
cubejs token -e "1 day" -p appId=1 -p userId=2
126+
npx cubejs-cli token -e "1 day" -p appId=1 -p userId=2
127127
```
128128

129129
## validate
@@ -133,7 +133,7 @@ The `validate` command checks models in a Cube project for validation errors.
133133
### Usage
134134

135135
```bash{promptUser: user}
136-
cubejs validate
136+
npx cubejs-cli validate
137137
```
138138

139139
### Example

0 commit comments

Comments
 (0)