> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Extract metadata
export const MultiRelatedLinks = ({sections = []}) => {
if (!sections || sections.length === 0) {
return null;
}
return
;
};
export const Link = ({href, children, className, ...props}) => {
const localizedHref = localizeLink(href);
return
{children}
;
};
This script extracts metadata details for all the
files and folders in any Box folder and
saves the result in a CSV spreadsheet for
each metadata template.
## Prerequisites
### Windows
Install the latest version of [.NET core](https://dotnet.microsoft.com/download).
### macOS & Linux
Install [PowerShell][pwsh]. Run the `pwsh` command to test the installation.
```bash theme={null}
pwsh
```
Depending on the directory you are
running the command in, the output may differ.
For example:
```bash theme={null}
PowerShell 7.2.5
Copyright (c) Microsoft Corporation.
https://aka.ms/powershell
Type 'help' to get help.
PS /Users/user/repos/boxcli/examples>
```
If you encounter issues make sure you installed both
[.NET core](https://dotnet.microsoft.com/download) and
[PowerShell][pwsh].
### Box CLI
To use the script, you need the Box CLI
installed and configured. You can do this by following
our quick start guide.
## Configure the script
1. Clone the `boxcli` GitHub repository and cd into this example's folder or download the files from the [`examples`][examples] directory.
```bash theme={null}
git clone https://github.com/box/boxcli.git
cd boxcli/examples/Metadata\ Extraction/
```
2. Specify the `folderID` and `userID` parameters to tell the script which folder to scan, and who is the user running the script.
```bash theme={null}
[string]$FolderID = "",
[string]$UserID = "",
```
If you don't want to specify the parameters directly in the script,
you can either pass them as flags or allow the script
to prompt you to enter them. A sample command with flags looks as follows:
```bash theme={null}
./Metadata-extraction.ps1 -folderId 123456789 -userId 123456789
```
## Run the script
1. Run the Powershell command.
```bash theme={null}
pwsh
```
2. Run the script.
```bash theme={null}
./Metadata-extraction.ps1 -folderId 123456789 -userId 123456789
```
When the script finishes, you will see the following
output or a similar one.
```bash theme={null}
Pulling data from Folder ID: 173961139760
metadata as user ID: 20718545815
Reading Item ID: 1016853559790
Metadata saved to: MetadataTemplate_properties.csv
```
## Logs
Logs are stored in a `logs` folder located in the main folder.
You have access to these log files:
* `Metadata-extraction_all.txt` that contains all log entries.
* `Metadata-extraction_errors.txt` that contains only errors.
[scripts]: https://github.com/box/boxcli/tree/main/examples
[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2
[console]: https://app.box.com/developers/console
[auth]: /guides/authentication/oauth2/oauth2-setup
[examples]: https://github.com/box/boxcli/tree/main/examples/Metadata%20Extraction