Home

Awesome

sku

Simple TUI written in go to play sudoku in the terminal

GO GHCR AUR Go Report Card

Table of Contents

Usage - Features - Testing

sku is a simple TUI for playing sudoku inside the terminal. It uses the awesome bubbletea TUI library for the UI.

Screenshots here

Disclaimer: there are probably many other sudoku TUIs around with all kind of features that sku does not have. PRs are welcomed but it is generally a better idea to just use those programs, since adding some features, like a pencil mode used to annotate the sudoku, would require too much effort.

<a id="orgab62fc1"></a>

Usage

With the go tool:

go install github.com/fedeztk/sku/cmd/sku@latest

Or from source:

# clone the repo
git clone https://github.com/fedeztk/sku.git
# install manually 
make install

In both cases make sure that you have the go bin directory in your path:

export PATH="$HOME/go/bin:$PATH"

If you are an Arch user there is also an AUR package available:

paru -S sku-git
sku            # use default mode (easy)

For more information about version and modes check the help (sku -h) <a id="org26baa6c"></a>

Features

<a id="org2744438"></a>

Testing

Development is done through docker, build the container with:

make docker-build

Check that the build went fine:

docker images | grep sku

Test it with:

make docker-run

Pre-built Docker image available here