# sudokus

> A JavaScript utility to solve sudokus.

Latest version **1.0.2** (published 2019-04-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install sudokus
pnpm add sudokus
yarn add sudokus
bun add sudokus
```

Provides the command `sudokus`.

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-04-10 |
| First published | 2016-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/sudokus) |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 5 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Dieter Luypaert |
| Maintainers | moeriki |
| Keywords | sudoku, puzzle, solver |

## Links

- npm: https://www.npmjs.com/package/sudokus
- Repository: https://github.com/Moeriki/node-sudokus
- Homepage: https://github.com/Moeriki/node-sudokus#readme
- Issues: https://github.com/Moeriki/node-sudokus/issues
- npm.io page: https://npm.io/package/sudokus

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ~1.1.3
- [table](https://npm.io/package/table.md) ~4.0.1
- [yargs](https://npm.io/package/yargs.md) ~6.5.0
- [lodash](https://npm.io/package/lodash.md) ~4.17.11
- [log-update](https://npm.io/package/log-update.md) ~1.0.2

## Recent versions

- 1.0.2 (latest) — 2019-04-10
- 1.0.1 — 2016-12-30
- 1.0.0 — 2016-12-30

## README

<p align="center">
  <h3 align="center">Sudokus</h3>
  <p align="center">A JavaScript utility to solve sudokus.<p>
  <p align="center"><img align="center" src="https://raw.githubusercontent.com/Moeriki/node-sudokus/master/demo.gif" height="480x"></p>
</p>

## CLI

### Install

```
$ npm install -g sudokus
```

### Usage

```shell
$ sudokus solve --help

$ sudokus solve ",,,2,9,,1,,,6,,,5,,1,,7,,,,,,,,,3,4,,,,,,,9,4,,4,5,,3,,,,6,2,2,,9,,,4,3,1,,,2,,,,,4,9,,,,6,,,8,,,,,4,3,,2,,,8,7"

$ sudokus solve "[[0,0,0,2,9,0,1,0,0],[6,0,0,5,0,1,0,7,0],[0,0,0,0,0,0,0,3,4],[0,0,0,0,0,0,9,4,0],[4,5,0,3,0,0,0,6,2],[2,0,9,0,0,4,3,1,0],[0,2,0,0,0,0,4,9,0],[0,0,6,0,0,8,0,0,0],[0,4,3,0,2,0,0,8,7]]"
```

## API

### Install

```
$ npm install --save sudokus
```

### Usage

```javascript
const sudokus = require('sudokus');

const solution = sudokus.solve([
    [0, 0, 0, 2, 9, 0, 1, 0, 0],
    [6, 0, 0, 5, 0, 1, 0, 7, 0],
    [0, 0, 0, 0, 0, 0, 0, 3, 4],
    [0, 0, 0, 0, 0, 0, 9, 4, 0],
    [4, 5, 0, 3, 0, 0, 0, 6, 2],
    [2, 0, 9, 0, 0, 4, 3, 1, 0],
    [0, 2, 0, 0, 0, 0, 4, 9, 0],
    [0, 0, 6, 0, 0, 8, 0, 0, 0],
    [0, 4, 3, 0, 2, 0, 0, 8, 7]
]);

// solution = [
//   [ 7, 8, 4, 2, 9, 3, 1, 5, 6 ],
//   [ 6, 3, 2, 5, 4, 1, 8, 7, 9 ],
//   [ 5, 9, 1, 6, 8, 7, 2, 3, 4 ],
//   [ 3, 1, 7, 8, 6, 2, 9, 4, 5 ],
//   [ 4, 5, 8, 3, 1, 9, 7, 6, 2 ],
//   [ 2, 6, 9, 7, 5, 4, 3, 1, 8 ],
//   [ 8, 2, 5, 1, 7, 6, 4, 9, 3 ],
//   [ 9, 7, 6, 4, 3, 8, 5, 2, 1 ],
//   [ 1, 4, 3, 9, 2, 5, 6, 8, 7 ]
// ]
```

---
_Source: https://npm.io/package/sudokus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._