Skip to content

wh3at/hex

Repository files navigation

hex

Interactive CLI automation workflow tool with ASCII art branding.

Features

  • 🎨 ASCII art logo display
  • ⌨️ Interactive command mode
  • 🚀 Built with React for CLI (Ink framework)
  • 🔧 TypeScript support
  • 🎭 Automation capabilities with Stagehand and Playwright

Install

Using npm

$ npm install --global hex

Using Bun (Recommended)

$ bun install

Usage

Start the application:

$ hex

Once the application starts, you'll see the HEX ASCII logo. Press / to enter command mode.

Available Commands

  • /version - Show version information
  • /help - Display help message with available commands

Controls

  • / - Enter command mode
  • Enter - Execute command
  • ESC - Cancel command input
  • Backspace - Delete characters

Development

Prerequisites

  • Node.js >= 16 or Bun >= 1.0.0
  • TypeScript

Build

# Using Bun
$ bun run build

# Using npm
$ npm run build

Development Mode

Run TypeScript compiler in watch mode:

# Using Bun
$ bun run dev

# Using npm
$ npm run dev

Run Application

# Using Bun
$ bun run start      # Build and run
$ bun run start:dev  # Run from source

# Using npm
$ npm run build && node dist/cli.js

Testing

Run the full test suite:

# Using Bun
$ bun test

# Using npm
$ npm test

Code Quality

Lint and format code using Biome:

# Lint only
$ bun run lint

# Format code
$ bun run format

# Lint and format
$ bun run check

Tech Stack

  • UI Framework: Ink - React for CLI
  • Runtime: Node.js (>=16) or Bun (>=1.0.0)
  • Language: TypeScript
  • Linter/Formatter: Biome
  • Test Runner: AVA
  • CLI Parser: Meow
  • Automation: Stagehand + Playwright
  • Validation: Zod
  • Environment Variables: dotenv

Project Structure

hex/
├── source/
│   ├── cli.tsx          # Entry point
│   ├── app.tsx          # Main React component
│   └── components/      # Reusable components
│       └── version.tsx  # Version display component
├── dist/                # Compiled JavaScript (generated)
├── test.tsx             # Test suite
└── package.json         # Project configuration

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •