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

# sf volume

> Volumes a job can mount

## `sf volume`

Volumes a job can mount

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf volume <subcommand>
```

| Command            | Description                         |
| ------------------ | ----------------------------------- |
| `sf volume create` | Create an empty volume              |
| `sf volume ls`     | List the volumes you can reference  |
| `sf volume push`   | Add a folder's files to a volume    |
| `sf volume rm`     | Delete a volume, or files inside it |

### `sf volume create`

Create an empty volume

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf volume create <NAME> [options]
```

| Argument | Description                                                           |
| -------- | --------------------------------------------------------------------- |
| `NAME`   | \<owner>/\<name>, or a bare name in your own namespace (**required**) |

| Option                | Description                           |
| --------------------- | ------------------------------------- |
| `--public`            | Let every signed-in user reference it |
| `--description`, `-d` | One line shown in the listing         |

### `sf volume ls`

List the volumes you can reference

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf volume ls
```

No options beyond `--help`.

### `sf volume push`

Add a folder's files to a volume

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf volume push <DIRECTORY> [options]
```

| Argument    | Description                                                               |
| ----------- | ------------------------------------------------------------------------- |
| `DIRECTORY` | Everything under it is uploaded, minus OS and Office noise (**required**) |

| Option                  | Description                                                                      |
| ----------------------- | -------------------------------------------------------------------------------- |
| `--name`, `-n`          | \<owner>/\<name>, or a bare name in your own namespace (**required**)            |
| `--concurrency` `<int>` | Uploads in flight. The right number depends on the link, not on us (default `8`) |

### `sf volume rm`

Delete a volume, or files inside it

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf volume rm <NAME> [options]
```

| Argument | Description                     |
| -------- | ------------------------------- |
| `NAME`   | \<owner>/\<name> (**required**) |

| Option         | Description                                                                            |
| -------------- | -------------------------------------------------------------------------------------- |
| `--path`, `-p` | Delete these files or directories instead of the whole volume; repeatable (repeatable) |
| `--yes`, `-y`  | Skip the confirmation                                                                  |
