blob: 036731b193657435ebef75f0b556e240add6ca44 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
---
title: OpenBBUserData Folder
sidebar_position: 8
description: The OpenBBUserData folder is where exports, routines, and other user-related content is saved and stored. Its default location is the home of the system user account.
keywords:
- OpenBBUserData folder
- settings
- data
- preferences
- exports
- CLI
- save
- routines
- xlsx
- csv
- user_settings.json
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="OpenBBUserData Folder | OpenBB CLI Docs" />
The OpenBBUserData folder is where exports, routines, and other user-related content is saved and stored.
:::info
If a new file is placed in the folder (like a Routine) the CLI will need to be reset before auto complete will recognize it.
:::
## Default Location
Its default location is the home of the system user account, similar to the following paths:
- macOS: `Macintosh HD/Users/<YOUR_USERNAME>/OpenBBUserData`
- Windows: `C:/Users/<YOUR_USERNAME>/OpenBBUserData`
This folder contains all things user-created. For example:
- Exported files
- Styles and themes
- Routines
- Logs
:::note
**Note:** With a WSL-enabled Windows installation, this folder will be under the Linux partition
:::
## Update Folder Location
The location of this folder can be set by the user by changing the user configuration file: `/home/your-user/.openbb_platform/user_settings.json`.
```json
{
...
"preferences": {
"data_directory": "/path/to/NewOpenBBUserData",
"export_directory": "/path/to/NewOpenBBUserData"
},
...
}
```
|
