jeans/etcher
jeans/etcher
1
0
Fork 0
mirror of https://github.com/balena-io/etcher.git synced 2025-04-20 05:17:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
etcher/lib/cli/README.md
Juan Cruz Viotti 2291321b46 refactor(GUI): remove the intermediate child writer proxy process (#1910) 
Etcher currently elevates a child writer proxy that itself spawns the
Etcher CLI in robot mode, parses the output, and proxies those messages
to the GUI application over IPC.

After these set of changes, Etcher elevates a single child writer
process that directly communicates back with the GUI using IPC. The main
purpose behind these changes is to simplify the overall architecture and
fix various issues caused by the current complex child process tree.

Here's a summary of the changes:

- Stop wrapping the Etcher CLI to perform writing
- Remove the robot option from the Etcher CLI (along with related
  documentation)
- Elevate a new `child-write.js` standalone executable
- Move the relevant bits of `lib/child-writer` to the `image-writer` GUI
  module
- Remove the `lib/child-writer` directory
- Add a new "Child died unexpectedly" Mixpanel event
- Floor state percentage in the flash state model

The above changes made is possible to tackle all the remaining issues
where the writer process would remain alive even if the parent died.

Change-Type: patch
Changelog-Entry: Ensure the writer process dies when the GUI application is killed.
See: https://github.com/resin-io/etcher/pull/1873
See: https://github.com/resin-io/etcher/pull/1843
Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
2018-01-04 20:46:09 +01:00

714 B
Raw Permalink Blame History

Etcher CLI

The Etcher CLI is a command line interface to the Etcher writer backend, and currently the only module in the "Etcher" umbrella that makes use of this backend directly.

This module also has the task of unmounting the drives before and after flashing.

Notice the Etcher CLI is not worried about elevation, and assumes it has enough permissions to continue, throwing an error otherwise.

Exit codes

The Etcher CLI uses certain exit codes to signal the result of the operation. These are documented in lib/shared/exit-codes.js and are also printed on the Etcher CLI help page.