This guide will walk you through installing DFX Dashboard and its prerequisite, dfx.

​
Installing dfx via dfxvm

Before installing DFX Dashboard, you need to install dfx, which is part of the Internet Computer SDK.

dfx is natively supported on Linux or macOS 12.* Monterey or later. For Windows users, you can run dfx using Windows Subsystem for Linux (WSL 2), although not all features may be supported.

To install dfx, we’ll use dfxvm, a tool for managing different versions of dfx.

1

Open your terminal

Launch your terminal application on macOS or Linux.

2

Install dfxvm

Run the following command to download and install the latest version of dfxvm:

sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"
3

Verify installation

After installation, you can verify the installation by running:

dfx --version

If you’re using a machine with Apple silicon, you’ll need to have Rosetta installed. You can install Rosetta by running softwareupdate --install-rosetta in your terminal.

​
System Requirements

Before installing DFX Dashboard, ensure your system meets these requirements:

Operating System

  • macOS 10.15+
  • Ubuntu 20.04+

Dependencies

  • dfx v0.25.0 or newer
  • Node.js v14.0.0 or newer

​
Installing DFX Dashboard

​
🍎 macOS (Apple Silicon | Intel)

1

Download the release

Download the latest release for macOS:

2

Install the application

  1. Open the downloaded file
  2. Drag the DFX Dashboard icon to the Applications directory

​
Using Bundled dfx

While it’s recommended to install dfx separately as described above, DFX Dashboard also provides a bundled version of dfx.

If you prefer not to install dfx separately or need to use a specific version, you can use the bundled dfx version in DFX Dashboard.

To use the bundled version:

1

Open DFX Dashboard

Launch DFX Dashboard from your applications menu.

2

Navigate to Settings

Go to the Settings page in the sidebar.

3

Toggle dfx version

Look for the option to toggle between system dfx and bundled dfx.

4

Select bundled dfx

Choose “Use Bundled DFX” to use the included version.

​
Verifying the Installation

After installation, follow these steps to verify that DFX Dashboard is correctly installed:

1

Launch the application

Open DFX Dashboard from your applications menu.

2

Check the About section

Navigate to the “About” section in the sidebar.

3

Verify version

Check the version number displayed to ensure it matches the version you downloaded.

​
Troubleshooting

​
Additional Resources

DFX Documentation

Official dfx command line reference

IC Developer Docs

Complete Internet Computer development guide

Community Forum

Get help from the community

GitHub Issues

Report bugs and request features

Ready to get started? Continue to the Quick Start Guide to set up your first project.