Skip to content
Documentation

Install Open Project

Install and open a project

Install Hexby, open your codebase, and start its first analysis.

Install Hexby, choose a project, and let Hexby map its UI.

Before you start

Have:

  • A Hexby account.
  • A React or Preact project using Vite or Next, or an Angular CLI project. Angular component previews require Angular 17 or newer.
  • Project dependencies installed.
  • Git installed on the same machine—even for local projects.

If Git is missing, install it for macOS, Windows, or Linux.

Install Hexby

Download Hexby
macOS
Apple silicon, macOS 13 or later
Windows
64-bit, Windows 10 or later
LinuxComing soon

Open the installer, launch Hexby, and sign in.

Open a project

On first launch, choose the path that matches your project:

Local project

Open a local project

Open the folder that contains the project root and its dependencies.

Drag & drop
  1. 01
    Find the project root

    Choose the folder that contains package.json and the lockfile.

  2. 02
    Open it in Hexby

    Select New → Open project, or drag the folder into the project picker.

  3. 03
    Let Hexby map the UI

    Wait for the workspace to load, then start exploring Pages and Components.

For a local project, open the folder that contains package.json and the lockfile. Choose the checkout and branch you intend to inspect.

If the project is not ready, install its dependencies or see Troubleshooting.

Preview App shows the opened project running with navigation, device controls, zoom, Comment, and Inspect.

Once the project opens, Preview App confirms the full application context.

Once the project is open, continue with First Analysis to understand the analysis and first previews.

To switch projects later, use the project control in the top-left of the workspace.