Install, Update, and Uninstall on macOS#

Learn how to install, update, or remove NVIDIA AI Workbench on macOS.

Agree to the NVIDIA AI Product Agreement

Before downloading or installing, please read the NVIDIA AI Product Agreement, the NVIDIA AI Workbench Shared Security Model, and our Data Privacy Policy.

By downloading, installing, or using the NVIDIA AI Workbench software, you agree to the terms of the NVIDIA AI Product Agreement (EULA). If you do not agree to the terms of the EULA, you are not authorized to download, install, or use NVIDIA AI Workbench. Before downloading and using NVIDIA AI Workbench, please read our Shared Security Model.

Prerequisites for Your macOS#

AI Workbench supports both x86_64 and ARM64 architectures for macOS.

  • MacOS 13 (Ventura) or higher

  • System resources:

    • 500 MB of disk space for the AI Workbench application

    • 30 to 40 GB of disk space for containers

    • 16 GB of RAM

Install AI Workbench on macOS#

  1. Download the AI Workbench Desktop Application

  2. Double-click the downloaded .dmg file to open it, and then drag the AI Workbench application into the Applications folder

  3. Double-click the AI Workbench icon in your Applications folder to open the application

  4. Follow the configuration prompts to complete the installation.

  5. Follow the onboarding steps to clone the Tutorial Project and get started.

Note

If you see a security warning about an app from an unidentified developer, go to System Settings > Privacy & Security and click Open Anyway.

Update AI Workbench#

When updates are available, automated notifications will appear every time you open AI Workbench until the update is installed.

When you get an update notification, just click Update Now to begin the update and follow the prompts.

You can manually check for updates in the Workbench icon in the Status Menu.

Note

If you update your local Workbench, you must also update any remote locations that are connected.

The connection requires API compatibility to work. See Update AI Workbench on a Remote System.

Uninstall AI Workbench#

  1. Run the following command in a shell:

    sudo -E $HOME/.nvwb/bin/nvwb-cli uninstall
    
  2. Confirm the uninstall by typing y and pressing Enter

  3. Move the AI Workbench application to the trash

Optional cleanup#

  • To remove the application files, run the following command to remove the .nvwb folder

    rm -rf $HOME/.nvwb
    
  • To remove your project repositories, run the following command

    rm -rf $HOME/nvidia-workbench/
    

FAQs#

What Gets Installed and Where?#

  • The application binaries: nvwb-cli, wb-svc, and credential-manager into $HOME/.nvwb/bin

  • Git and Git-LFS: Installed or updated system wide

  • Docker Desktop or Podman: Installed or updated system wide

  • Homebrew: Installed or updated system wide

Can I Just Install the Workbench CLI Instead of the Desktop App?#

Yes. On macOS you do not need to install the Desktop App.

  1. Open a terminal, copy, paste and run the following command:

    1mkdir -p $HOME/.nvwb/bin && \
    2curl -L https://workbench.download.nvidia.com/stable/workbench-cli/$(curl -L -s https://workbench.download.nvidia.com/stable/workbench-cli/LATEST)/nvwb-cli-$(uname)-$(uname -m) --output $HOME/.nvwb/bin/nvwb-cli && \
    3chmod +x $HOME/.nvwb/bin/nvwb-cli && \
    4sudo -E $HOME/.nvwb/bin/nvwb-cli install
    
  2. Follow the text-based interface prompts to complete the installation:

    • Use arrow keys to navigate and Enter to select options

    • Select either Docker or Podman as your container runtime

Note

You can update the CLI by running the same command as above.

You can uninstall the CLI with sudo -E $HOME/.nvwb/bin/nvwb-cli uninstall.

Next Steps#