/support-toolkit

Command line tools containerized for balena device support

Primary LanguageLuaApache License 2.0Apache-2.0

Support Toolkit

Provides tools containerized for balena device support, accessible via a bash shell.

Tools

A tool name link is to local docs on how to run it in a support context for a balena device.

Tool Description
bash Provides shell for the container
lshw List hardware on device
nano Text editor with a command bar
ncat Networking tool, including simple web server
tcpdump Collect network packets for Wireshark

Running

To run the toolkit interactively from a bash shell:

   balena run --rm -it kb2ma/support-toolkit

To execute a command directly, provide it at startup, like this example to list device hardware with lshw.

   balena run --rm --privileged kb2ma/support-toolkit -c "lshw -short"

A particular tool may require host networking or privileged operation, like lshw in the example above. See the tool doc links above for specifics.

Development

Build with ./build-images.sh <docker-hub-repository>

Add any howto/documentation to a file in the doc directory, with the name of the tool. Update the Tools section above to link to it as well.