> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vessl.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# vessl service

## Overview

Run `vessl service --help` to view list of commands, or `vessl service [COMMAND] --help` to view individual command instructions.

When required options are not provided by the user, it will automatically enter interactive mode (and prompt user to select from given options)

### List all services

```
vessl service list
```

### Read service

```
vessl service read [OPTIONS]
```

| Option           | Description                                  |
| ---------------- | -------------------------------------------- |
| `--service`      | Name of service.                             |
| `-d`, `--detail` | Whether to show details about each revision. |

### Create a revision (and launch)

```
vessl service create [OPTIONS]
```

| Option                       | Description                                                                                                                    |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `-f`, `--file`               | Path to YAML file for creating service.                                                                                        |
| `--from-hub`                 | Model key to be found in VESSL Hub. This will automatically create a revision, without having to directly provide a YAML file. |
| `-s`, `--service-name`       | Name of service, either from existing or new service.                                                                          |
| `-l`, `--launch`             | Whether to launch the service after creating.                                                                                  |
| `-a`, `--set-current-active` | Whether to set the current service as active, Steps: 1. launches the revision 2. enables the endpoint 3. stops other revisions |
| `--port`                     | If the cluster uses NodePort custom endpoint type, this option defines the port to use for the service.                        |
| `--subdomain`                | If the cluster uses Subdomain custom endpoint type, this option defines the subdomain to use for the service.                  |
| `--force`                    | Whether to force the creation of service with aborting ongoing rollout if exists.                                              |
| `--serverless`               | Whether to set service to serverless mode.                                                                                     |

### Terminate a specific revision

```
vessl service terminate [OPTIONS]
```

| Option           | Description         |
| ---------------- | ------------------- |
| `--service`      | Name of service.    |
| `-n`, `--number` | Number of revision. |

### Update autoscaling options for a specific revision

```
vessl service scale [OPTIONS]
```

| Option           | Description                                                |
| ---------------- | ---------------------------------------------------------- |
| `--service`      | Name of service.                                           |
| `-n`, `--number` | Number of revision.                                        |
| `--min`          | Minimum number of replicas.                                |
| `--max`          | Maximum number of replicas.                                |
| `--target`       | Target resource utilization.                               |
| `--metric`       | Metric for autoscaling: 'cpu', 'nvidia.com/gpu', 'memory'. |

### Update traffic split for a service

```
vessl service split-traffic [OPTIONS]
```

| Option           | Description                                                                                                |
| ---------------- | ---------------------------------------------------------------------------------------------------------- |
| `--service`      | Name of service.                                                                                           |
| `-n`, `--number` | Number of revision. You can pass multiple.                                                                 |
| `-w`, `--weight` | Percentage of traffic that should be directed to this revision. The sum of traffics should be exactly 100. |

### Create a YAML file

```
vessl service create-yaml [SERVICE_NAME] [OPTIONS]
```

| Option            | Description                                                          |
| ----------------- | -------------------------------------------------------------------- |
| `-k`, `--api-key` | Asks you the organization secret to use for API key of your service. |

## Deprecated

### (Deprecated) Update traffic split for a service

```
vessl serve update [OPTIONS]
```

| Option           | Description                                                                                                |
| ---------------- | ---------------------------------------------------------------------------------------------------------- |
| `--service`      | Name of service.                                                                                           |
| `-n`, `--number` | Number of revision. You can pass multiple.                                                                 |
| `-w`, `--weight` | Percentage of traffic that should be directed to this revision. The sum of traffics should be exactly 100. |

### (Deprecated) List all revisions

```
vessl serve revision list [OPTIONS]
```

| Option      | Description      |
| ----------- | ---------------- |
| `--service` | Name of service. |

### (Deprecated) Show current status and information about a revision

```
vessl serve revision show [OPTION]
```

| Option           | Description         |
| ---------------- | ------------------- |
| `--service`      | Name of service.    |
| `-n`, `--number` | Number of revision. |

### (Deprecated) Terminate a specific revision

```
vessl serve revision terminate [OPTION]
```

| Option           | Description         |
| ---------------- | ------------------- |
| `--service`      | Name of service.    |
| `-n`, `--number` | Number of revision. |

### (Deprecated) Show current status of the gateway of service

```
vessl serve gateway show [OPTION]
```

| Option      | Description      |
| ----------- | ---------------- |
| `--service` | Name of service. |