diff options
| author | Danglewood <85772166+deeleeramone@users.noreply.github.com> | 2024-05-14 09:08:18 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-14 16:08:18 +0000 |
| commit | 05322de3b70aff8c7a2b4a93085b64d47d7bec3f (patch) | |
| tree | 2d3190e7a118e24ee4e6a87cab657f91b927d439 | |
| parent | 8d060dc0717e2ce9cde06ffc7523ea465c920a0e (diff) | |
add linux stuff to pre-requisites (#6411)
| -rw-r--r-- | website/content/cli/installation.md | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/website/content/cli/installation.md b/website/content/cli/installation.md index 51c1819538a..67056410d79 100644 --- a/website/content/cli/installation.md +++ b/website/content/cli/installation.md @@ -28,6 +28,29 @@ Please refer to the [OpenBB Platform install documentation](/platform/installati If the OpenBB Platform is not already installed, the `openbb-cli` package will install the default components. ::: +### Linux Requirements + +Linux users will need to take additional steps prior to installation. + +#### Rust + +Rust and Cargo must be installed, system-level, and in the PATH. Follow the instructions on-screen to install and add to PATH in the shell profile. + +```bash +curl --proto '=https' --tlsv1.3 https://sh.rustup.rs -sSf | sh +``` + +#### Webkit + +Next, install webkit. + +- Debian-based / Ubuntu / Mint: `sudo apt install libwebkit2gtk-4.0-dev` + +- Arch Linux / Manjaro: `sudo pacman -S webkit2gtk` + +- Fedora: `sudo dnf install gtk3-devel webkit2gtk3-devel` + + ## PyPI Within your existing OpenBB environment, install `openbb-cli` with: @@ -36,7 +59,6 @@ Within your existing OpenBB environment, install `openbb-cli` with: pip install openbb-cli ``` - The installation script adds `openbb` to the PATH within your Python environment. The application can be launched from any path, as long as the environment is active. ```console |