# Filesystem CLI

Python API: `luxonis_ml.utils.__main__`

## Functions

| Name | Description |
| --- | --- |
|
[`delete`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/__main__.md)
| Delete a file from remote storage. |
|
[`get`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/__main__.md)
| Download a file from remote storage. |
|
[`ls`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/__main__.md)
| List files in the remote directory. |
|
[`put`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/__main__.md)
| Upload a file to remote storage. |

### function `delete`

```python
def delete(url: str)
```

Delete a file from remote storage.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `url` | `str` | URL of the file to delete. | required |

### function `get`

```python
def get(url: str, save_dir: Path | None = None)
```

Download a file from remote storage.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `url` | `str` | URL of the file to download. | required |
| `save_dir` | `Path | None` | Directory to save the file. Defaults to current working directory. | `None` |

### function `ls`

```python
def ls(
    url: str,
    *,
    recursive: Annotated[bool, Parameter(alias='-r', negative=())] = False,
    typ: Annotated[Literal['file', 'directory', 'all'], Parameter(name=['--type', '-t'])] = 'all',
)
```

List files in the remote directory.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `url` | `str` | URL of the directory to list. | required |
| `recursive` | `Annotated[bool, Parameter(alias='-r', negative=())]` | Whether to list files recursively. | `False` |
| `typ` | `Annotated[Literal['file', 'directory', 'all'], Parameter(name=['--type', '-t'])]` | Type of files to list. | `'all'` |

### function `put`

```python
def put(file: Path, url: str)
```

Upload a file to remote storage.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `file` | `Path` | Path to the file to upload. | required |
| `url` | `str` | URL of the file. | required |

## Module Attributes

| Name | Description |
| --- | --- |
|
[`app`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/__main__.md)
| |

### variable `app`

```python
app = App(help='Filesystem utilities.')
```
