List Existing Files with CLI

Print a list of files that exist in the deepset workspace you specify. The list includes the file name and ID, URL, size, creation timestamp, and metadata.

Prerequisites

Install the SDK
Generate an API Key to connect to a deepset workspace.

List Files

Pass your API key and the name of the deepset workspace whose files you want to list. (You can also skip this step and just pass your API key and workspace in the list-files command.)
```
# This command prompts you to pass the deepset API key and workspace name
deepset-cloud login
```
Run the following command to get a list of the files in the workspace you specified:
```
 deepset-cloud list-files
```

A table with file details is displayed in the console.

Examples

This command lists all files whose names contain the string hilton_hotel that exist in the "hotels" workspace. The list is broken up into batches of 20 files. It also includes the API key to connect to deepset:
```
deepset-cloud list-files --api-key <API_KEY> --workspace-name hotels --name "hilton-hotel" --batch-size 20
```

Updated 17 days ago

Related Links

deepset Cloud CLI