# sketches

> Sketches is a command-line tool inspired by package manager like NPM. If you are fascinated by the **package.json** then you will love **Sketches.yml**.

Latest version **0.0.18** (published 2019-11-21) · MIT license · 0 weekly downloads

## Install

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

Provides the command `sketches`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.18 |
| Published | 2019-11-21 |
| First published | 2019-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 59.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Francesco Bianco |
| Maintainers | francescobianco |

## Links

- npm: https://www.npmjs.com/package/sketches
- Repository: https://github.com/fulminati/arduinodk
- Homepage: https://github.com/fulminati/arduinodk#readme
- Issues: https://github.com/fulminati/arduinodk/issues
- npm.io page: https://npm.io/package/sketches

## Dependencies (13)

- [boor](https://npm.io/package/boor.md) 0.0.3
- [cliz](https://npm.io/package/cliz.md) 0.0.16
- [glob](https://npm.io/package/glob.md) ^7.1.2
- [colors](https://npm.io/package/colors.md) ^1.1.2
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [is-root](https://npm.io/package/is-root.md) ^2.0.0
- [nodemon](https://npm.io/package/nodemon.md) ^1.18.4
- [username](https://npm.io/package/username.md) ^5.1.0
- [deepmerge](https://npm.io/package/deepmerge.md) ^2.1.1
- [nodejs-fu](https://npm.io/package/nodejs-fu.md) ^0.2.2
- [serialport](https://npm.io/package/serialport.md) ^8.0.5
- [string-argv](https://npm.io/package/string-argv.md) ^0.1.1
- [html-minifier](https://npm.io/package/html-minifier.md) ^3.5.13

## Recent versions

- 0.0.18 (latest) — 2019-11-21
- 0.0.16 — 2019-11-21
- 0.0.15 — 2019-11-21
- 0.0.14 — 2019-11-19

## README

# Sketches

Sketches is a command-line tool inspired by package manager like NPM.  
If you are fascinated by the **package.json** then you will love **Sketches.yml**.

## Get Started

Install the Sketches via NPM
```bash
$ npm install -g sketches
```

 - See more on [Install NodeJS and NPM](https://github.com/fulminati/sketches/wiki/install-nodejs-and-npm)

### Create project from scratch

Create your first project
```bash
$ sketches init ArduinoProject
$ cd ArduinoProject
```
 - See more on [Project management](https://github.com/fulminati/sketches/wiki/project-management)

### Configure your project

Each Sketches project can be configured via the 'Sketches.yml' file

```yml
name: <MyArduinoProject>
version: 0.0.1
sketches:
  MyArduinoProject:
    board: uno
    port: COM3
```

 - See more on [Sketches.yml reference](https://github.com/fulminati/arduinodk/wiki/Reference:-sketches.yml)

### Verify operation

Verify source code of current project
```bash
$ arduinodk verify
```

### Upload operation

Upload binary into arduino board
```bash
$ arduinodk upload
```

## Roadmap

| Command       | Progress | Features |
|---------------|:--------:|----------|
| apply-filters | 10%      |          |
| create-sketch | 10%      |          |
| flash         | 10%      |          |
| init          | 10%      |          |
| install       | 10%      |          |
| ls            | 10%      |          |
| monitor       | 10%      |          |
| rename-sketch | 10%      |          |
| sandbox       | 10%      |          |
| upload        | 10%      |          |
| verify        | 10%      |          |

## See more
 - [Install Boards and Libraries](https://github.com/fulminati/arduinodk/wiki/Install-boards-and-libraries)

## References
 - https://github.com/arduino/Arduino/blob/ide-1.5.x/build/shared/manpage.adoc
 - https://h3ron.com/post/programmare-lesp8266-ovvero-arduino-con-il-wifi-a-meno-di-2/
 - https://cassiopeia.hk/rgb-wifi/
 - https://www.anginf.de/?p=600
 - https://github.com/doleron/esp8266-1-channel-relay-board-with-mqtt

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