Skip to main content

Getting Started with HexaJS

Welcome! This guide will walk you through setting up your environment, installing the Hexa CLI globally, and scaffolding your first cross-browser extension. By the end of this page, you will have a working project ready to load into Chrome or Firefox.

Prerequisites

  • Node.js ≥ 18
  • pnpm, npm, or yarn

Install the CLI

npm install -g @hexajs-dev/cli

Scaffold a new project

hexa new hexa-extension
cd hexa-extension
pnpm install

Verify

hexa build --platform chrome

Your extension is now compiled and ready to be loaded into Chrome (or any Chromium-based browser, like Edge or Brave).

Cross-Browser Support

HexaJS is built for the modern web. You can easily target other browsers by changing the platform flag! Try running hexa build --platform firefox or hexa build --platform safari.