# nerves v1.13.0 - Table of Contents

## GUIDES

- [Changelog](changelog.md)

- Introduction
  - [Getting Started](getting-started.md)
  - [Installation](installation.md)
  - [Using Nerves](using-nerves.md)

- Core
  - [Connecting to a Nerves Target](connecting-to-a-nerves-target.md)
  - [Frequently Asked Questions](faq.md)
  - [Hardware Interfaces](hardware-interfaces.md)
  - [IEx with Nerves](iex-with-nerves.md)
  - [Supported Targets](supported-targets.md)
  - [User Interfaces](user-interfaces.md)

- Advanced
  - [Advanced Configuration](advanced-configuration.md)
  - [Building Nerves Systems using nerves_systems repository](building-systems.md)
  - [Compiling Non-BEAM Code](compiling-non-beam-code.md)
  - [Customizing Your Nerves System](customizing-systems.md)
  - [Environment variables](environment-variables.md)
  - [Experimental features](experimental-features.md)
  - [Nerves Internals](internals.md)
  - [Systems](systems.md)
  - [Updating Projects](updating-projects.md)

## Modules

- [Nerves.Artifact](Nerves.Artifact.md): Package artifacts are the product of compiling a package with a
specific toolchain.

- [Nerves.Artifact.BuildRunner](Nerves.Artifact.BuildRunner.md): Defines the Nerves build runner behaviour
- [Nerves.Artifact.BuildRunners.Docker](Nerves.Artifact.BuildRunners.Docker.md): Produce an artifact for a package using Docker.
- [Nerves.Artifact.BuildRunners.Local](Nerves.Artifact.BuildRunners.Local.md): Builds an artifact locally.
- [Nerves.Artifact.Resolvers.URI](Nerves.Artifact.Resolvers.URI.md): Downloads an artifact from a remote http location.

- [Nerves.Env](Nerves.Env.md): Contains package info for Nerves dependencies
- [Nerves.Erlinit](Nerves.Erlinit.md): Decode and encode erlinit.config files
- [Nerves.Package](Nerves.Package.md): Defines a Nerves package struct and helper functions.
- [Nerves.Package.Platform](Nerves.Package.Platform.md): Defines the Nerves package platform behaviour
- [Nerves.Port](Nerves.Port.md): The code from this file was copied in from MuonTrap
https://github.com/fhunleth/muontrap

- [Nerves.System.BR](Nerves.System.BR.md): Package builder for Buildroot-based Nerves systems

- [Nerves.Utils.WSL](Nerves.Utils.WSL.md): This module contains utility functions to assist in detecting a Windows
Subsystem for Linux environment as well as functions to convert paths between
the Windows host and Linux.

## Mix Tasks

- [mix burn](Mix.Tasks.Burn.md): Writes the generated firmware image to an attached SDCard or file.
- [mix compile.nerves_package](Mix.Tasks.Compile.NervesPackage.md): Compile a Nerves package into a local artifact
- [mix firmware](Mix.Tasks.Firmware.md): Build a firmware image for the selected target platform.
- [mix firmware.burn](Mix.Tasks.Firmware.Burn.md): This task calls `mix firmware` & `mix burn` to burn a new firmware to a SDCard
- [mix firmware.gen.gdb](Mix.Tasks.Firmware.Gen.Gdb.md): Generates a helper shell script for using gdb to analyze core dumps
- [mix firmware.image](Mix.Tasks.Firmware.Image.md): Create a firmware image file that can be copied byte-for-byte to an SDCard
or other memory device.
- [mix firmware.metadata](Mix.Tasks.Firmware.Metadata.md): This task calls `fwup` to report the firmware stored in the currently built
firmware bundle. No firmware is built, so this task will fail if the firmware
bundle doesn't exist.
- [mix firmware.patch](Mix.Tasks.Firmware.Patch.md): Generate a firmware patch from a source and target firmware and output a new
firmware file with the patch contents. The source firmware file
- [mix firmware.unpack](Mix.Tasks.Firmware.Unpack.md): Unpack the firmware so that its contents can be inspected locally.
- [mix nerves.artifact](Mix.Tasks.Nerves.Artifact.md): Creates a Nerves artifact for a Nerves system or toolchain
- [mix nerves.artifact.details](Mix.Tasks.Nerves.Artifact.Details.md): Prints Nerves artifact details.
- [mix nerves.clean](Mix.Tasks.Nerves.Clean.md): Cleans dependencies and build artifacts
- [mix nerves.discover](Mix.Tasks.Nerves.Discover.md): Discover Nerves devices on the local network using mDNS
- [mix nerves.info](Mix.Tasks.Nerves.Info.md): Prints Nerves system information.
- [mix nerves.system.shell](Mix.Tasks.Nerves.System.Shell.md): Open a shell in a system's build directory.