{"id":14971085,"url":"https://github.com/notpaulmartin/autoflash","last_synced_at":"2026-01-18T10:00:37.682Z","repository":{"id":36936108,"uuid":"231420188","full_name":"notpaulmartin/autoflash","owner":"notpaulmartin","description":"An easy-to-use CLI for handling ESP8266 (NodeMCU) images: erase, download and flash with ease","archived":false,"fork":false,"pushed_at":"2022-03-25T23:51:39.000Z","size":359,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-03T17:45:25.058Z","etag":null,"topics":["cli","esp8266","esp8266-arduino","espressif","esptool","nodejs","nodejs-cli","nodemcu","nodemcu-arduino","nodemcu-esp8266","nodemcu-lua"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/notpaulmartin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-02T16:34:06.000Z","updated_at":"2025-01-07T11:24:21.000Z","dependencies_parsed_at":"2022-08-08T18:30:31.729Z","dependency_job_id":null,"html_url":"https://github.com/notpaulmartin/autoflash","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/notpaulmartin/autoflash","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notpaulmartin%2Fautoflash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notpaulmartin%2Fautoflash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notpaulmartin%2Fautoflash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notpaulmartin%2Fautoflash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/notpaulmartin","download_url":"https://codeload.github.com/notpaulmartin/autoflash/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notpaulmartin%2Fautoflash/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28534203,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","esp8266","esp8266-arduino","espressif","esptool","nodejs","nodejs-cli","nodemcu","nodemcu-arduino","nodemcu-esp8266","nodemcu-lua"],"created_at":"2024-09-24T13:44:41.716Z","updated_at":"2026-01-18T10:00:37.483Z","avatar_url":"https://github.com/notpaulmartin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Autoflash\n\n## A CLI to handle images for the ESP8266\n\n**_Flash an ESP8266 in no time (nodemcu \u0026amp; arduino)_**\n\n[![npm](https://img.shields.io/npm/v/autoflash)](https://www.npmjs.com/package/autoflash)\n\nIn building build-yours.com, a company developing and selling products based on ESP8266s, a large problem we encountered was \\\n_How do you flash a large number of chips with little effort in a short amount time?_\n\nTo solve this, I created autoflash, of which I am now publishing the third generation.\n\nYou can wipe a chip clean, create backups and upload them again. \\\n**Uploading to a 4MB chip takes a mere 15s.** \\\nAutoflash automatically selects the port depending on the OS.\n\n## Installation\n\nAutoflash uses [npm](https://www.npmjs.com/get-npm) as a means of distribution.\n\n```\n$ npm i -g autoflash\n```\n\n## Usage\n\nAutoflash works with binary files. The only reason we use the file extension `.afl` is so that we know that they are ESP8266 images, but it can also be omitted.\n\nAdding the flag `-v` or `--verbose` tells autoflash to display everything it does in detail.\n\nAvailable commands: \\\n[`download`](#downloading) \\\n[`upload`](#uploading) \\\n[`erase`](#wiping) \\\n[`device` / `devices`](#port-selection)\n\n### Downloading\n\n```\n$ autoflash download [backup.afl] [--port=\u003cauto\u003e]\n```\n\n- If no filename is specified, the file is downloaded to the current working directory with the name \"backup.afl\".\n\n- If no port is specified, autoflash decides which port to use\n\n### Uploading\n\n```\n$ autoflash upload file.afl [--port=\u003cauto\u003e]\n```\n\n- If no port is specified, autoflash decides which port to use\n\n### Wiping\n\n```\n$ autoflash erase [--port=\u003cauto\u003e]\n```\n\n- If no port is specified, autoflash decides which port to use\n\n### Port selection\n\nFor the above commands, a port can be specified using the optional `--port` flag. If no port is specified, autoflash detects an active port and uses it.\n\nThe port automatically selected port can be viewed with\n\n```\n$ autoflash device\n```\n\nTo get a list of available ports, use\n\n```\n$ autoflash devices\n```\n\n## Todo\n\nIf you want to contribute but don't know where to start, these are a few things that would be cool to have:\n\n- Complain when specified port doesn't exist\n- Complain on error with esptool.py\n- JS API so that it can be integrated as a dependency in other programs\n- Progress bar\n  - Download\n  - Upload\n  - Erase\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\n[GNU General Public License v2.0](https://choosealicense.com/licenses/gpl-2.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotpaulmartin%2Fautoflash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotpaulmartin%2Fautoflash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotpaulmartin%2Fautoflash/lists"}