diff --git a/apps/docs/content/bun/how-to/create.mdx b/apps/docs/content/bun/how-to/create.mdx index 023f7025..2cddf7e7 100644 --- a/apps/docs/content/bun/how-to/create.mdx +++ b/apps/docs/content/bun/how-to/create.mdx @@ -297,10 +297,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -363,8 +363,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/deno/how-to/create.mdx b/apps/docs/content/deno/how-to/create.mdx index 653f182e..d1136a4b 100644 --- a/apps/docs/content/deno/how-to/create.mdx +++ b/apps/docs/content/deno/how-to/create.mdx @@ -293,10 +293,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -358,8 +358,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/dotnet/how-to/create.mdx b/apps/docs/content/dotnet/how-to/create.mdx index 3bb4fbcb..f36781b6 100644 --- a/apps/docs/content/dotnet/how-to/create.mdx +++ b/apps/docs/content/dotnet/how-to/create.mdx @@ -298,10 +298,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -363,8 +363,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/elixir/how-to/create.mdx b/apps/docs/content/elixir/how-to/create.mdx index 3f535e1c..9764a930 100644 --- a/apps/docs/content/elixir/how-to/create.mdx +++ b/apps/docs/content/elixir/how-to/create.mdx @@ -293,10 +293,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -358,8 +358,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/features/pipeline.mdx b/apps/docs/content/features/pipeline.mdx index 84eaaac2..c29f4be6 100644 --- a/apps/docs/content/features/pipeline.mdx +++ b/apps/docs/content/features/pipeline.mdx @@ -396,22 +396,22 @@ Usage: zcli service deploy pathToFileOrDir [flags] Flags: - --archiveFilePath string If set, zCLI creates a tar.gz archive with the application code in the required path relative + --archive-file-path string If set, zCLI creates a tar.gz archive with the application code in the required path relative to the working directory. By default, no archive is created. - --deployGitFolder Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI + --deploy-git-folder Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI looks for zerops.yaml in the working directory. -h, --help the service deploy command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. - --serviceId string If you have access to more than one service, you must specify the service ID for which the + --service-id string If you have access to more than one service, you must specify the service ID for which the command is to be executed. - --versionName string Adds a custom version name. Automatically filled if the VERSIONNAME environment variable exists. - --workingDir string Sets a custom working directory. Default working directory is the current directory. (default "./") - --zeropsYamlPath string Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI + --version-name string Adds a custom version name. Automatically filled if the VERSIONNAME environment variable exists. + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") + --zerops-yaml-path string Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI looks for zerops.yaml in the working directory. ``` -`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. +`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. Place `zerops.yaml` in the working directory. diff --git a/apps/docs/content/gleam/how-to/create.mdx b/apps/docs/content/gleam/how-to/create.mdx index cfd8ebc1..18660502 100644 --- a/apps/docs/content/gleam/how-to/create.mdx +++ b/apps/docs/content/gleam/how-to/create.mdx @@ -294,10 +294,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -359,8 +359,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/go/how-to/create.mdx b/apps/docs/content/go/how-to/create.mdx index c1183f37..03275d43 100644 --- a/apps/docs/content/go/how-to/create.mdx +++ b/apps/docs/content/go/how-to/create.mdx @@ -268,10 +268,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -333,8 +333,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/java/how-to/create.mdx b/apps/docs/content/java/how-to/create.mdx index 15e84ab3..5b9d654d 100644 --- a/apps/docs/content/java/how-to/create.mdx +++ b/apps/docs/content/java/how-to/create.mdx @@ -268,10 +268,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -333,8 +333,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/keydb/how-to/control.mdx b/apps/docs/content/keydb/how-to/control.mdx index e2a9c59d..42bdce76 100644 --- a/apps/docs/content/keydb/how-to/control.mdx +++ b/apps/docs/content/keydb/how-to/control.mdx @@ -24,13 +24,13 @@ zCLI is the Zerops command-line tool. To stop and start the KeyDB service via th ```sh Usage: - zcli service stop [serviceIdOrName] [flags] + zcli service stop [service-id-or-name] [flags] Flags: -h, --help the enable Zerops subdomain command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. - --serviceId string If you have access to more than one service, you must specify the service ID for which the + --service-id string If you have access to more than one service, you must specify the service ID for which the command is to be executed. ``` @@ -46,9 +46,9 @@ Usage: Flags: -h, --help the service start command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. - --serviceId string If you have access to more than one service, you must specify the service ID for which the + --service-id string If you have access to more than one service, you must specify the service ID for which the command is to be executed. ``` diff --git a/apps/docs/content/keydb/how-to/create.mdx b/apps/docs/content/keydb/how-to/create.mdx index e3b52a88..2c47cd06 100644 --- a/apps/docs/content/keydb/how-to/create.mdx +++ b/apps/docs/content/keydb/how-to/create.mdx @@ -270,10 +270,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -322,8 +322,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/mariadb/how-to/create.mdx b/apps/docs/content/mariadb/how-to/create.mdx index e0c06c3f..14e34eb9 100644 --- a/apps/docs/content/mariadb/how-to/create.mdx +++ b/apps/docs/content/mariadb/how-to/create.mdx @@ -295,10 +295,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -350,8 +350,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/nginx/how-to/create.mdx b/apps/docs/content/nginx/how-to/create.mdx index 8ed1f70a..3deea81e 100644 --- a/apps/docs/content/nginx/how-to/create.mdx +++ b/apps/docs/content/nginx/how-to/create.mdx @@ -306,10 +306,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -372,8 +372,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/nodejs/how-to/create.mdx b/apps/docs/content/nodejs/how-to/create.mdx index ca1b63e9..cfa1a915 100644 --- a/apps/docs/content/nodejs/how-to/create.mdx +++ b/apps/docs/content/nodejs/how-to/create.mdx @@ -296,10 +296,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -361,8 +361,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/object-storage/how-to/create.mdx b/apps/docs/content/object-storage/how-to/create.mdx index 5e7f71fd..04dfbbaa 100644 --- a/apps/docs/content/object-storage/how-to/create.mdx +++ b/apps/docs/content/object-storage/how-to/create.mdx @@ -314,10 +314,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -371,8 +371,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/php/how-to/create.mdx b/apps/docs/content/php/how-to/create.mdx index e5a57496..2417b83c 100644 --- a/apps/docs/content/php/how-to/create.mdx +++ b/apps/docs/content/php/how-to/create.mdx @@ -294,10 +294,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -360,8 +360,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/postgresql/how-to/create.mdx b/apps/docs/content/postgresql/how-to/create.mdx index bfd561f8..8a9d9690 100644 --- a/apps/docs/content/postgresql/how-to/create.mdx +++ b/apps/docs/content/postgresql/how-to/create.mdx @@ -305,10 +305,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project will be created. - --workingDie string Sets a custom working directory. The default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. The default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -357,8 +357,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command will be executed. ``` diff --git a/apps/docs/content/python/how-to/create.mdx b/apps/docs/content/python/how-to/create.mdx index e51c5c1f..30633838 100644 --- a/apps/docs/content/python/how-to/create.mdx +++ b/apps/docs/content/python/how-to/create.mdx @@ -298,10 +298,10 @@ Usage: zcli project project-import importYamlPath [flags] Flags: - -h, --help the project import command. - --orgId string If you have access to more than one organization, you must specify the org ID for which the + -h, --help Help for the project import command. + --org-id string If you have access to more than one organization, you must specify the org ID for which the project is to be created. - --workingDie string Sets a custom working directory. Default working directory is the current directory. (default "./") + --working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./") ``` Zerops will create a project and one or more services based on the `description.yaml` content. @@ -363,8 +363,8 @@ Usage: zcli project service-import importYamlPath [flags] Flags: - -h, --help the project service import command. - --projectId string If you have access to more than one project, you must specify the project ID for which the + -h, --help Help for the project service import command. + -P, --project-id string If you have access to more than one project, you must specify the project ID for which the command is to be executed. ``` diff --git a/apps/docs/content/references/cli/commands.mdx b/apps/docs/content/references/cli/commands.mdx index 37d90e48..82aead7d 100644 --- a/apps/docs/content/references/cli/commands.mdx +++ b/apps/docs/content/references/cli/commands.mdx @@ -46,13 +46,13 @@ zcli logout Connects to the Zerops VPN. ```sh -zcli vpn up [projectId] [flags] +zcli vpn up [project-id] [flags] ``` **Flags:** - `--auto-disconnect` - Automatically disconnect from VPN if already connected - `--mtu int` - Set custom MTU value for Wireguard interface (default: 1420) -- `--projectId string` - Required when you have access to multiple projects +- `-P, --project-id string` - Required when you have access to multiple projects :::note You can set a default project ID for VPN connections in a `.zcli.yml` file or via the `ZEROPS_PROJECTID` environment variable. See the [Configuration](/references/cli/configuration) page for details. @@ -80,47 +80,64 @@ Lists all projects you have access to. zcli project list ``` +### project create + +Creates a new project for specified organization. + +```sh +zcli project create [flags] +``` + +**Flags:** +- `--env-isolation string` - Environment isolation rule [service, none] (default: "service") +- `--mode string` - Project mode [light, serious] (default: "light") +- `--name string` - Project name +- `--org-id string` - Organization ID to create project for +- `--out string` - Output format using Go template syntax +- `--ssh-isolation string` - SSH isolation rules (default: "vpn") +- `--tags strings` - Project tags (comma-separated list or repeated flag) + ### project delete Deletes a project and all its services. ```sh -zcli project delete [projectId] [flags] +zcli project delete [project-id] [flags] ``` **Flags:** - `--confirm` - Skip confirmation prompts for destructive operations -- `--projectId string` - Required when you have access to multiple projects +- `-P, --project-id string` - Required when you have access to multiple projects ### project project-import Creates a new project with one or more services from a YAML definition. ```sh -zcli project project-import [flags] +zcli project project-import importYamlPath [flags] ``` **Flags:** -- `--orgId string` - Organization ID where the project should be created (required for multiple organizations) -- `--workingDir string` - Sets a custom working directory (default: "./") +- `--org-id string` - Organization ID where the project should be created (required for multiple organizations) +- `--working-dir string` - Sets a custom working directory (default: "./") ### project service-import Creates one or more services in an existing project from a YAML definition. ```sh -zcli project service-import [flags] +zcli project service-import importYamlPath [flags] ``` **Flags:** -- `--projectId string` - Required when you have access to multiple projects +- `-P, --project-id string` - Required when you have access to multiple projects ### scope project Sets the default project for commands that require a project ID. ```sh -zcli scope project [projectId] +zcli scope project [project-id] ``` :::tip @@ -146,36 +163,59 @@ zcli service list [flags] ``` **Flags:** -- `--projectId string` - Required when you have access to multiple projects +- `-P, --project-id string` - Required when you have access to multiple projects + +### service create + +Creates a new service for specified project. + +```sh +zcli service create [flags] +``` + +**Flags:** +- `--env strings` - Environment variables to be set as secrets (comma-separated or repeated flag) +- `--env-file string` - File with environment variables (max 1.0 MiB) +- `--env-isolation string` - Environment isolation rule [service, none] (default: "service") +- `--mode string` - Service mode [ha, non_ha] (default: "non_ha") +- `--name string` - Service name +- `--noop` - Creates service only if none with the same name exists +- `--out string` - Output format using Go template syntax +- `-P, --project-id string` - Required when you have access to multiple projects +- `--ssh-isolation string` - SSH isolation rules (default: "vpn") +- `--start-without-code` - Start service immediately without deploy +- `--working-dir string` - Sets custom working directory (default: "./") +- `--zerops-yaml-path string` - Sets custom path to zerops.yml file ### service push Builds your application in Zerops and deploys it. This is the recommended way to deploy your code. ```sh -zcli service push [serviceIdOrName] [flags] +zcli service push [service-id-or-name] [flags] ``` **Flags:** -- `--archiveFilePath string` - Creates a tar.gz archive with application code -- `-g, --deployGitFolder` - Include the .git folder in the upload -- `--disableLogs` - Disable logs during push -- `-v, --verbose` - Log additional debug data to the zCLI [debug log file](/references/cli/configuration#logging-configuration) -- `--projectId string` - Required when you have access to multiple projects -- `--serviceId string` - Required when you have access to multiple services +- `--archive-file-path string` - Creates a tar.gz archive with application code +- `-g, --deploy-git-folder` - Include the .git folder in the upload +- `--disable-logs` - Disable logs during push +- `--no-git` - Upload entire working directory as-is (cannot be combined with --workspace-state or --deploy-git-folder) +- `-P, --project-id string` - Required when you have access to multiple projects +- `-S, --service-id string` - Required when you have access to multiple services - `--setup string` - Choose setup to use from zerops.yml -- `--versionName string` - Adds a custom version name -- `--workingDir string` - Sets a custom working directory (default: "./") -- `-w, --workspaceState string` - Defines version of workspace to push: +- `-v, --verbose` - Log additional debug data to the zCLI [debug log file](/references/cli/configuration#logging-configuration) +- `--version-name string` - Adds a custom version name +- `--working-dir string` - Sets a custom working directory (default: "./") +- `-w, --workspace-state string` - Defines version of workspace to push: - `clean` - pushes the HEAD without local changes - `staged` - pushes only staged files - `all` - pushes all staged and unstaged files (default) -- `--zeropsYamlPath string` - Sets a custom path to the zerops.yml file +- `--zerops-yaml-path string` - Sets a custom path to the zerops.yml file :::tip You can also use `zcli push` as a shorthand for `zcli service push`. -To avoid specifying `--projectId` and `--serviceId` flags repeatedly, you can set default values in a `.zcli.yml` file or via environment variables. See the [Configuration](/references/cli/configuration) page for details. +To avoid specifying `--project-id` and `--service-id` flags repeatedly, you can set default values in a `.zcli.yml` file or via environment variables. See the [Configuration](/references/cli/configuration) page for details. ::: ### service deploy @@ -183,7 +223,7 @@ To avoid specifying `--projectId` and `--serviceId` flags repeatedly, you can se Deploys your application to Zerops. Similar to `push` but focuses on deployment only. ```sh -zcli service deploy [serviceIdOrName] +zcli service deploy [service-id-or-name] ``` **Flags:** @@ -194,38 +234,38 @@ Same as service push command. Commands to start or stop a Zerops service. ```sh -zcli service start [serviceIdOrName] [flags] -zcli service stop [serviceIdOrName] [flags] +zcli service start [service-id-or-name] [flags] +zcli service stop [service-id-or-name] [flags] ``` **Flags for both commands:** -- `--projectId string` - Required when you have access to multiple projects -- `--serviceId string` - Required when you have access to multiple services +- `-P, --project-id string` - Required when you have access to multiple projects +- `-S, --service-id string` - Required when you have access to multiple services ### service delete Deletes a Zerops service. ```sh -zcli service delete [serviceIdOrName] [flags] +zcli service delete [service-id-or-name] [flags] ``` **Flags:** - `--confirm` - Skip confirmation prompts for destructive operations -- `--projectId string` - Required when you have access to multiple projects -- `--serviceId string` - Required when you have access to multiple services +- `-P, --project-id string` - Required when you have access to multiple projects +- `-S, --service-id string` - Required when you have access to multiple services ### service enable-subdomain Enables access to your service through a Zerops subdomain. ```sh -zcli service enable-subdomain [serviceIdOrName] [flags] +zcli service enable-subdomain [service-id-or-name] [flags] ``` **Flags:** -- `--projectId string` - Required when you have access to multiple projects -- `--serviceId string` - Required when you have access to multiple services +- `-P, --project-id string` - Required when you have access to multiple projects +- `-S, --service-id string` - Required when you have access to multiple services ### service log @@ -237,14 +277,14 @@ zcli service log [flags] **Flags:** - `--follow` - Continuously poll for new log messages -- `--format ` - Log output format (FULL, SHORT, JSON, JSONSTREAM) -- `--formatTemplate