Termdle

A fully-featured wordle clone that runs entirely in your terminal! Built with TypeScript, React, and Ink.

Installation

Run with npx

npx termdle

or Install Termdle globally

npm install -g termdle

Then simply run:

termdle

Features

✅ Classic Wordle Gameplay

• 6 attempts to guess a 5-letter word
• Color-coded feedback: Green (correct position), Yellow (wrong position), Gray (not in word)

✅ Beautiful Terminal UI

• Modern React-based interface using Ink
• Live keyboard showing letter states

✅ Statistics Tracking

• Games played, won, win percentage
• Current and maximum win streaks
• Guess distribution histogram
• Persistent stats saved to your home directory

Project Structure

├── src/
│   ├── cli/
│   │   ├── index.tsx          # Main CLI entry point
│   │   └── ui/
│   │       ├── App.tsx        # Main React application
│   │       ├── atoms/         # Jotai state management
│   │       ├── components/    # React components
|   |       ├── hooks/         # React hooks
│   │       └── utils/         # UI utilities
│   └── core/
│       ├── game.ts            # Core game logic and word evaluation
│       ├── stats.ts           # Statistics tracking and persistence
│       └── words.ts           # Word lists for targets and valid guesses
├── package.json               # Project configuration
└── tsconfig.json             # TypeScript configuration

Local Development

Prerequisites

• node (>= 20.0.0)
• pnpm

Setup

Clone the repository

git clone [email protected]:k-dang/termdle.git

Install dependencies

pnpm install

Development Workflow

Start the tsdown bundler in watch mode

pnpm run dev

Start the cli app in another terminal window

pnpm run start

Type checking

pnpm run typecheck

Run linting

pnpm run lint

Format code

pnpm run format

Bumping version

Make sure to bump package versions on package json

pnpm version major

pnpm version minor

pnpm version patch

Publishing

This repo is setup to publish upon merges to main via Github actions. You can also run the commands manually.

Bundle the package

pnpm run build

Publish the package

pnpm run publish