Skip to content

Commit 738f857

Browse files
authored
Merge pull request #281 from zeropsio/update-zcli-commands-signature
update zcli commands signature, flags and descriptions
2 parents 1875ded + 5193dbd commit 738f857

File tree

23 files changed

+234
-184
lines changed

23 files changed

+234
-184
lines changed

apps/docs/content/bun/how-to/create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -297,10 +297,10 @@ Usage:
297297
zcli project project-import importYamlPath [flags]
298298

299299
Flags:
300-
-h, --help the project import command.
301-
--orgId string If you have access to more than one organization, you must specify the org ID for which the
300+
-h, --help Help for the project import command.
301+
--org-id string If you have access to more than one organization, you must specify the org ID for which the
302302
project is to be created.
303-
--workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./")
303+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
304304
```
305305

306306
Zerops will create a project and one or more services based on the `description.yaml` content.
@@ -363,8 +363,8 @@ Usage:
363363
zcli project service-import importYamlPath [flags]
364364
365365
Flags:
366-
-h, --help the project service import command.
367-
--projectId string If you have access to more than one project, you must specify the project ID for which the
366+
-h, --help Help for the project service import command.
367+
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
368368
command is to be executed.
369369
```
370370

apps/docs/content/deno/how-to/create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -293,10 +293,10 @@ Usage:
293293
zcli project project-import importYamlPath [flags]
294294

295295
Flags:
296-
-h, --help the project import command.
297-
--orgId string If you have access to more than one organization, you must specify the org ID for which the
296+
-h, --help Help for the project import command.
297+
--org-id string If you have access to more than one organization, you must specify the org ID for which the
298298
project is to be created.
299-
--workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./")
299+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
300300
```
301301

302302
Zerops will create a project and one or more services based on the `description.yaml` content.
@@ -358,8 +358,8 @@ Usage:
358358
zcli project service-import importYamlPath [flags]
359359
360360
Flags:
361-
-h, --help the project service import command.
362-
--projectId string If you have access to more than one project, you must specify the project ID for which the
361+
-h, --help Help for the project service import command.
362+
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
363363
command is to be executed.
364364
```
365365

apps/docs/content/dotnet/how-to/create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -298,10 +298,10 @@ Usage:
298298
zcli project project-import importYamlPath [flags]
299299

300300
Flags:
301-
-h, --help the project import command.
302-
--orgId string If you have access to more than one organization, you must specify the org ID for which the
301+
-h, --help Help for the project import command.
302+
--org-id string If you have access to more than one organization, you must specify the org ID for which the
303303
project is to be created.
304-
--workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./")
304+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
305305
```
306306

307307
Zerops will create a project and one or more services based on the `description.yaml` content.
@@ -363,8 +363,8 @@ Usage:
363363
zcli project service-import importYamlPath [flags]
364364
365365
Flags:
366-
-h, --help the project service import command.
367-
--projectId string If you have access to more than one project, you must specify the project ID for which the
366+
-h, --help Help for the project service import command.
367+
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
368368
command is to be executed.
369369
```
370370

apps/docs/content/elixir/how-to/create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -293,10 +293,10 @@ Usage:
293293
zcli project project-import importYamlPath [flags]
294294

295295
Flags:
296-
-h, --help the project import command.
297-
--orgId string If you have access to more than one organization, you must specify the org ID for which the
296+
-h, --help Help for the project import command.
297+
--org-id string If you have access to more than one organization, you must specify the org ID for which the
298298
project is to be created.
299-
--workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./")
299+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
300300
```
301301

302302
Zerops will create a project and one or more services based on the `description.yaml` content.
@@ -358,8 +358,8 @@ Usage:
358358
zcli project service-import importYamlPath [flags]
359359
360360
Flags:
361-
-h, --help the project service import command.
362-
--projectId string If you have access to more than one project, you must specify the project ID for which the
361+
-h, --help Help for the project service import command.
362+
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
363363
command is to be executed.
364364
```
365365

apps/docs/content/features/pipeline.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -396,22 +396,22 @@ Usage:
396396
zcli service deploy pathToFileOrDir [flags]
397397
398398
Flags:
399-
--archiveFilePath string If set, zCLI creates a tar.gz archive with the application code in the required path relative
399+
--archive-file-path string If set, zCLI creates a tar.gz archive with the application code in the required path relative
400400
to the working directory. By default, no archive is created.
401-
--deployGitFolder Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI
401+
--deploy-git-folder Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI
402402
looks for zerops.yaml in the working directory.
403403
-h, --help the service deploy command.
404-
--projectId string If you have access to more than one project, you must specify the project ID for which the
404+
--project-id string If you have access to more than one project, you must specify the project ID for which the
405405
command is to be executed.
406-
--serviceId string If you have access to more than one service, you must specify the service ID for which the
406+
--service-id string If you have access to more than one service, you must specify the service ID for which the
407407
command is to be executed.
408-
--versionName string Adds a custom version name. Automatically filled if the VERSIONNAME environment variable exists.
409-
--workingDir string Sets a custom working directory. Default working directory is the current directory. (default "./")
410-
--zeropsYamlPath string Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI
408+
--version-name string Adds a custom version name. Automatically filled if the VERSIONNAME environment variable exists.
409+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
410+
--zerops-yaml-path string Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI
411411
looks for zerops.yaml in the working directory.
412412
```
413413

414-
`pathToFileOrDir` defines paths to directories and/or files relative to the working directory. The working directory defaults to the current directory and can be changed using the `--workingDir` flag.
414+
`pathToFileOrDir` defines paths to directories and/or files relative to the working directory. The working directory defaults to the current directory and can be changed using the `--working-dir` flag.
415415

416416
Place `zerops.yaml` in the working directory.
417417

apps/docs/content/gleam/how-to/create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -294,10 +294,10 @@ Usage:
294294
zcli project project-import importYamlPath [flags]
295295

296296
Flags:
297-
-h, --help the project import command.
298-
--orgId string If you have access to more than one organization, you must specify the org ID for which the
297+
-h, --help Help for the project import command.
298+
--org-id string If you have access to more than one organization, you must specify the org ID for which the
299299
project is to be created.
300-
--workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./")
300+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
301301
```
302302

303303
Zerops will create a project and one or more services based on the `description.yaml` content.
@@ -359,8 +359,8 @@ Usage:
359359
zcli project service-import importYamlPath [flags]
360360
361361
Flags:
362-
-h, --help the project service import command.
363-
--projectId string If you have access to more than one project, you must specify the project ID for which the
362+
-h, --help Help for the project service import command.
363+
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
364364
command is to be executed.
365365
```
366366

apps/docs/content/go/how-to/create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -268,10 +268,10 @@ Usage:
268268
zcli project project-import importYamlPath [flags]
269269

270270
Flags:
271-
-h, --help the project import command.
272-
--orgId string If you have access to more than one organization, you must specify the org ID for which the
271+
-h, --help Help for the project import command.
272+
--org-id string If you have access to more than one organization, you must specify the org ID for which the
273273
project is to be created.
274-
--workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./")
274+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
275275
```
276276

277277
Zerops will create a project and one or more services based on the `description.yaml` content.
@@ -333,8 +333,8 @@ Usage:
333333
zcli project service-import importYamlPath [flags]
334334
335335
Flags:
336-
-h, --help the project service import command.
337-
--projectId string If you have access to more than one project, you must specify the project ID for which the
336+
-h, --help Help for the project service import command.
337+
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
338338
command is to be executed.
339339
```
340340

apps/docs/content/java/how-to/create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -268,10 +268,10 @@ Usage:
268268
zcli project project-import importYamlPath [flags]
269269

270270
Flags:
271-
-h, --help the project import command.
272-
--orgId string If you have access to more than one organization, you must specify the org ID for which the
271+
-h, --help Help for the project import command.
272+
--org-id string If you have access to more than one organization, you must specify the org ID for which the
273273
project is to be created.
274-
--workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./")
274+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
275275
```
276276

277277
Zerops will create a project and one or more services based on the `description.yaml` content.
@@ -333,8 +333,8 @@ Usage:
333333
zcli project service-import importYamlPath [flags]
334334
335335
Flags:
336-
-h, --help the project service import command.
337-
--projectId string If you have access to more than one project, you must specify the project ID for which the
336+
-h, --help Help for the project service import command.
337+
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
338338
command is to be executed.
339339
```
340340

apps/docs/content/keydb/how-to/control.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ zCLI is the Zerops command-line tool. To stop and start the KeyDB service via th
2424

2525
```sh
2626
Usage:
27-
zcli service stop [serviceIdOrName] [flags]
27+
zcli service stop [service-id-or-name] [flags]
2828

2929
Flags:
3030
-h, --help the enable Zerops subdomain command.
31-
--projectId string If you have access to more than one project, you must specify the project ID for which the
31+
--project-id string If you have access to more than one project, you must specify the project ID for which the
3232
command is to be executed.
33-
--serviceId string If you have access to more than one service, you must specify the service ID for which the
33+
--service-id string If you have access to more than one service, you must specify the service ID for which the
3434
command is to be executed.
3535
```
3636

@@ -46,9 +46,9 @@ Usage:
4646

4747
Flags:
4848
-h, --help the service start command.
49-
--projectId string If you have access to more than one project, you must specify the project ID for which the
49+
--project-id string If you have access to more than one project, you must specify the project ID for which the
5050
command is to be executed.
51-
--serviceId string If you have access to more than one service, you must specify the service ID for which the
51+
--service-id string If you have access to more than one service, you must specify the service ID for which the
5252
command is to be executed.
5353
```
5454

apps/docs/content/keydb/how-to/create.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -270,10 +270,10 @@ Usage:
270270
zcli project project-import importYamlPath [flags]
271271
272272
Flags:
273-
-h, --help the project import command.
274-
--orgId string If you have access to more than one organization, you must specify the org ID for which the
273+
-h, --help Help for the project import command.
274+
--org-id string If you have access to more than one organization, you must specify the org ID for which the
275275
project is to be created.
276-
--workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./")
276+
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")
277277
```
278278

279279
Zerops will create a project and one or more services based on the `description.yaml` content.
@@ -322,8 +322,8 @@ Usage:
322322
zcli project service-import importYamlPath [flags]
323323
324324
Flags:
325-
-h, --help the project service import command.
326-
--projectId string If you have access to more than one project, you must specify the project ID for which the
325+
-h, --help Help for the project service import command.
326+
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
327327
command is to be executed.
328328
```
329329

0 commit comments

Comments
 (0)