@pixelkit-labs/cli 1.4.3 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @pixelkit-labs/cli
|
|
2
2
|
|
|
3
|
-
Command-line diagnostics for [PixelKit](https://www.npmjs.com/package/
|
|
3
|
+
Command-line diagnostics for [PixelKit](https://www.npmjs.com/package/@pixelkit-labs/sdk). Its only command,
|
|
4
4
|
`pixelkit doctor`, answers "why is everything showing —?" before you file an issue.
|
|
5
5
|
|
|
6
6
|
PixelKit hooks report `source: 'unavailable'` and render an em dash when a reading cannot be taken
|
|
@@ -40,7 +40,7 @@ npx pixelkit doctor
|
|
|
40
40
|
6. **Whether `adb reverse tcp:8081 tcp:8081` is set**, so a development client can reach Metro on
|
|
41
41
|
localhost.
|
|
42
42
|
|
|
43
|
-
Each check is reported as `PASS`, `FAIL`, `N/A
|
|
43
|
+
Each check is reported as `PASS`, `FAIL`, `N/A` or `UNKN` ("could not be determined" — the check
|
|
44
44
|
itself could not be run, for example because adb is missing or the device went offline).
|
|
45
45
|
`doctor` never guesses a result: an inconclusive check is reported as such, the same discipline
|
|
46
46
|
PixelKit hooks use for `source: 'unavailable'`.
|
|
@@ -61,4 +61,9 @@ pixelkit doctor [--package <id>] [--serial <serial>]
|
|
|
61
61
|
`0` when every check passed or was not applicable. `1` when any check failed, or could not be
|
|
62
62
|
determined at all.
|
|
63
63
|
|
|
64
|
+
## Documentation
|
|
65
|
+
|
|
66
|
+
[https://pixelkit-labs.github.io/pixelkit-docs/](https://pixelkit-labs.github.io/pixelkit-docs/) covers the hooks this command
|
|
67
|
+
diagnoses: each one's inputs, outputs, and what `source: 'unavailable'` means for it.
|
|
68
|
+
|
|
64
69
|
MIT
|