Fuchsia's developer tool


    Usage: ffx [-c <config...>] [-e <env>] [--machine <machine>] [--schema] [--stamp <stamp>] [-t <target>] [--timeout <timeout>] [-l <log-level>] [--isolate-dir <isolate-dir>] [-v] [-o <log-output>] [--no-environment] [--strict] [-d] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -c, --config | set config values (key=value, JSON string, or file path). |
| -e, --env | override path to environment config file. |
| --machine | machine output format: json, json-pretty, raw. |
| --schema | output JSON schema for machine output. Requires --machine. |
| --stamp | write exit code to stamp file (file path). |
| -t, --target | apply operations to single or multiple targets. |
| --timeout | override proxy timeout (default: 1s). |
| -l, --log-level | set log level: Info (default), Error, Warn, Trace. |
| --isolate-dir | isolate config/sockets in dir (overrides FFX_ISOLATE_DIR). |
| -v, --verbose | log output to stdio based on log level. |
| -o, --log-output | log destination: stdout/stderr. Overrides log.dir. |
| --no-environment | disable file config; use CLI/defaults only (hermetic). |
| --strict | strict mode: no daemon/discovery, direct connect, RO config. |
| -d, --direct | connect directly to the target. Unnecessary, as this is now the default. |

| **Subcommands** |   |
|---|---|
| [assembly](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_assembly) | Assemble images |
| [audio](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio) | Interact with the audio subsystem. |
| [auth](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_auth) | Generate Fuchsia authorization credentials. |
| [bluetooth](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth) | Issue a command to Sapphire, the Bluetooth system. |
| [completion](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_completion) | Generate shell completions for ffx |
| [component](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component) | Discover and manage components |
| [config](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config) | View and switch default and user configurations |
| [coverage](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_coverage) | Show coverage from test outputs |
| [debug](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug) | Start a debugging session. |
| [devices](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_devices) | List all targets (alias for ffx target list) |
| [doctor](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_doctor) | Run common checks for the ffx tool and host environment |
| [driver](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver) | Support driver development workflows |
| [echo](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_echo) | run echo test against the target |
| [efi](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_efi) | Manipulate efi partition |
| [emu](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu) | Start and manage Fuchsia emulators. |
| [forward](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_forward) | Forward connections between host and target device. |
| [fuzz](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz) | Start and manage fuzzers. |
| [gce](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_gce) | Start and manage Fuchsia instances directly on Google Compute Engine (GCE). |
| [inspect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_inspect) | Query data exposed by components via the Inspect API. |
| [log](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_log) | Display logs from a target device |
| [monitor](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_monitor) | Start a local server to monitor status. |
| [net](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net) | View and manage target network configuration |
| [package](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package) | Create and publish Fuchsia packages |
| [platform](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_platform) | Manage platform build prerequisites |
| [power](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_power) | Control system power features |
| [process](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_process) | Processes related commands |
| [product](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product) | Discover and access product bundle metadata and image data. |
| [product-bundle](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product-bundle) | Manage product bundles. NOTE: 'list' and 'get' have been moved to 'ffx product' |
| [profile](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile) | Profile run-time information from various subsystems |
| [profiler](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profiler) | Interact with the profiling subsystem. |
| [repository](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository) | Inspect and manage package repositories |
| [scrutiny](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny) | Audit the security of Fuchsia |
| [sdk](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_sdk) | Modify or query the installed SDKs |
| [session](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session) | Control the session component. |
| [setui](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui) | Modify and query settings. |
| [speedtest](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_speedtest) | Test ffx latency and throughput between the host and target. |
| [starnix](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_starnix) | Control starnix containers |
| [storage](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_storage) | Manage Fuchsia Filesystems. |
| [target](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target) | Interact with a target device or emulator |
| [test](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_test) | Run test suite |
| [trace](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace) | Collect, aggregate, and visualize traces |
| [triage](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_triage) | Analyze Logs and Inspect in snapshots to find problems. |
| [uart](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_uart) | Interact with the UART subsystem. |
| [uart-driver](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_uart-driver) | Driver daemon for UART transport |
| [usb](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_usb) | Collect and view telemetry for USB controllers and devices |
| [usb-driver](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_usb-driver) | Drive USB devices to/from ffx |
| [verify-ssh-keys](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_verify-ssh-keys) | Check target access keys in $FUCHSIA_DIR, \~/.ssh, or agent. |
| [version](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_version) | Print out ffx tool and daemon versions |
| [wlan](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan) | Developer tool for manipulating WLAN state. |
| [wm](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wm) | Control views presented by the window manager. |

## assembly

Assemble images


    Usage:  ffx assembly [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [create-system](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_assembly_create-system) | Create the system images. |
| [create-update](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_assembly_create-update) | construct an UpdatePackage using images and package. |
| [product](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_assembly_product) | Arguments for performing a high-level product assembly operation. |
| [size-check](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_assembly_size-check) | Perform size checks (on packages or product based on the sub-command). |

### create-system

Create the system images.


    Usage:  ffx assembly create-system --platform <platform> --image-assembly-config <image-assembly-config> --outdir <outdir> --gendir <gendir> [--include-account] [--base-package-name <base-package-name>] [--mode <mode>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --platform | the platform artifacts directory. this is needed in order to retrieve the assembly binary. |
| --image-assembly-config | the configuration file that specifies the packages, binaries, and settings specific to the product being assembled. |
| --outdir | the directory to write the assembled system to. |
| --gendir | the directory to write generated intermediate files to. |
| --include-account | whether to include an account partition in the FVMs. |
| --base-package-name | name to give the Base Package. this is useful if you must publish multiple base packages to the same TUF repository. |
| --mode | change the default mode assembly runs in to produce test images. |

### create-update

construct an UpdatePackage using images and package.


    Usage:  ffx assembly create-update --partitions <partitions> [--system-a <system-a>] [--system-r <system-r>] --epoch <epoch> [--rewrite-default-repo <rewrite-default-repo>] [--subpackage-blobs-package-name <subpackage-blobs-package-name>] [--update-package-name <update-package-name>] --outdir <outdir> [--gendir <gendir>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --partitions | path to a partitions config, which specifies where in the partition table the images are put. |
| --system-a | path to an images manifest, which specifies images to put in slot A. |
| --system-r | path to an images manifest, which specifies images to put in slot R. |
| --epoch | backstop OTA version. Fuchsia will reject updates with a lower epoch. |
| --rewrite-default-repo | rewrite package repository URLs to use this package URL hostname. |
| --subpackage-blobs-package-name | name to give the Subpackage Blobs Package. This is currently only used by OTA tests to allow publishing multiple subpackage blob packages to the same amber repository without naming collisions. |
| --update-package-name | name to give the Update Package. This is currently only used by OTA tests to allow publishing multiple update packages to the same amber repository without naming collisions. |
| --outdir | directory to write the UpdatePackage. |
| --gendir | directory to write intermediate files. |

### product

Arguments for performing a high-level product assembly operation.


    Usage:  ffx assembly product --product <product> --board-config <board-config> --outdir <outdir> --gendir <gendir> [--input-bundles-dir <input-bundles-dir>] [--platform-artifacts <platform-artifacts>] [--package-validation <package-validation>] [--custom-kernel-aib <custom-kernel-aib>] [--custom-boot-shim-aib <custom-boot-shim-aib>] [--suppress-overrides-warning] [--developer-overrides <developer-overrides>] [--include-example-aib-for-tests <include-example-aib-for-tests>] [--mode <mode>] [--board-input-bundle-sets <board-input-bundle-sets...>] [--product-input-bundles <product-input-bundles...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product | the product configuration directory. |
| --board-config | the board configuration directory. |
| --outdir | the directory to write assembled outputs to. |
| --gendir | the directory to write generated intermediate files to. |
| --input-bundles-dir | \[DEPRECATED\] the directory in which to find the platform artifacts |
| --platform-artifacts | the directory in which to find the platform artifacts |
| --package-validation | disable validation of the assembly's packages |
| --custom-kernel-aib | path to an AIB containing a customized kernel zbi to use instead of the one in the platform AIBs. |
| --custom-boot-shim-aib | path to an AIB containing a customized qemu_kernel boot shim to use instead of the in the platform AIBs. |
| --suppress-overrides-warning | whether to hide the warning that shows the overrides that are enabled. This can be helpful to disable for test assemblies. |
| --developer-overrides | path to a file specifying developer-level overrides for assembly. |
| --include-example-aib-for-tests | flag stating whether the example AIB should be included. |
| --mode | change the default mode assembly runs in to produce test images. |
| --board-input-bundle-sets | a list of board input bundle sets to override with. |
| --product-input-bundles | a list of product input bundles to override with. |

### size-check

Perform size checks (on packages or product based on the sub-command).


    Usage:  ffx assembly size-check [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [package](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_assembly_size-check_package) | Measure package sizes and verify they fit in the specified budgets. Exit status is 2 when one or more budgets are exceeded, and 1 when a failure prevented the budget verification to happen. |
| [product](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_assembly_size-check_product) | (Not implemented yet) Check that the set of all blobs included in the product fit in the blobfs capacity. |

#### package

Measure package sizes and verify they fit in the specified budgets. Exit status is 2 when one or more budgets are exceeded, and 1 when a failure prevented the budget verification to happen.


    Usage:  ffx assembly size-check package --budgets <budgets> [--blob-sizes <blob-sizes...>] [--blobfs-layout <blobfs-layout>] [--gerrit-output <gerrit-output>] [-v] [--verbose-json-output <verbose-json-output>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --budgets | path to a JSON file containing the list of size budgets. Each size budget has a `name`, a `size` which is the maximum number of bytes, and `packages` a list of path to manifest files. |
| --blob-sizes | path to a `blobs.json` file. It provides the size of each blob composing the package on device. |
| --blobfs-layout | the layout of blobs in blobfs. |
| --gerrit-output | path where to write the verification report, in JSON format. |
| -v, --verbose | show the storage consumption of each component broken down by package regardless of whether the component exceeded its budget. |
| --verbose-json-output | path where to write the verbose JSON output. |

#### product

(Not implemented yet) Check that the set of all blobs included in the product fit in the blobfs capacity.


    Usage:  ffx assembly size-check product [--auth <auth>] --assembly-manifest <assembly-manifest> [--base-assembly-manifest <base-assembly-manifest>] [-v] [--visualization-dir <visualization-dir>] [--gerrit-output <gerrit-output>] [--size-breakdown-output <size-breakdown-output>] [--blobfs-creep-budget <blobfs-creep-budget>] [--platform-resources-budget <platform-resources-budget>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --auth | use specific auth mode for oauth2 (see examples; default: pkce). |
| --assembly-manifest | path to the images.json. |
| --base-assembly-manifest | path to the past images.json which will be used to compare with the current images.json to produce a diff. |
| -v, --verbose | whether to show the verbose output. |
| --visualization-dir | path to the directory where HTML visualization should be stored. |
| --gerrit-output | path where to write the gerrit size report. |
| --size-breakdown-output | path where to write the size breakdown. |
| --blobfs-creep-budget | maximum amount that the size of blobfs can increase in one CL. This value is propagated to the gerrit size report. |
| --platform-resources-budget | maximum amount of bytes the platform resources can consume. |

## audio

Interact with the audio subsystem.


    Usage:  ffx audio [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [device](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device) | Interact directly with device hardware. The flags on the device command filter the list of available devices. Commands that operate on a single device pick the first matching device, after filtering. For example, if the target has only one device, and no filter flags are provided, `ffx audio device` will use that device by default. |
| [gen](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_gen) | Generate an audio signal. Outputs a WAV file written to stdout. |
| [list-devices](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_list-devices) | Prints all available audio devices on target |
| [play](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_play) | Reads a WAV file from stdin and sends the audio data to audio_core's AudioRenderer API. |
| [record](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_record) | Records audio data from audio_core's AudioCapturer API and outputs a WAV file to stdout. |

**Examples**

```
Generate a 5s long audio signal with 440Hz frequency and write to a file: 
    $ ffx audio gen sine --frequency 440 --duration 5s --format 48000,uint8,1ch > ~/sine.wav 

Play a wav file using audio_core API: 
    $ cat ~/sine.wav | ffx audio play 

Record audio signal to a file using audio_core API: 
    $ ffx audio record --duration 1s --format 48000,uint8,1ch > ~/recording.wav

List available audio devices on target: 
    $ ffx audio device list

Print information about a specific audio device on target: 
    $ ffx audio device --name 3d99d780 info

Play a wav file directly to device hardware: 
    $ cat ~/sine.wav | ffx audio device play
```

**Notes**

-

  ```
  Format parameters: Some commands take a '--format ' argument for describing audio PCM format.
  The  argument has the pattern: ,,
      SampleRate: Integer
      SampleType options: uint8, int16, int32, float32
      Channels: ch

  example: --format 48000,float32,2ch
  ```

### device

Interact directly with device hardware. The flags on the device command filter the list of available devices. Commands that operate on a single device pick the first matching device, after filtering. For example, if the target has only one device, and no filter flags are provided, `ffx audio device` will use that device by default.


    Usage:  ffx audio device [--name <name>] [--token-id <token-id>] [--direction <direction>] [--type <type>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | device devfs node name. e.g. 3d99d780 for the devfs path /dev/class/audio-input/3d99d780. |
| --token-id | device token ID, for a device in the audio device registry. Only applies if the audio device registry is available on the target. |
| --direction | device direction. Accepted values: input, output. Play and record will use output and input respectively by default. |
| --type | device type. Accepted values: StreamConfig, Composite. |

| **Subcommands** |   |
|---|---|
| [agc](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_agc) | Request to enable or disable automatic gain control for the stream. |
| [gain](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_gain) | Request to set the gain of the stream, in decibels. |
| [info](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_info) | Show information about a specific audio device. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_list) | Lists audio devices. |
| [mute](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_mute) | Request to mute a stream. |
| [play](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_play) | Send audio data directly to device ring buffer. |
| [record](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_record) | Capture audio data directly from ring buffer. |
| [reset](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_reset) | Reset device hardware. |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_set) | Set a device property. |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_start) | Start device hardware. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_stop) | Stop device hardware. |
| [unmute](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_unmute) | Request to unmute a stream. |

**Examples**

```
Show information about a specific device:

    $ ffx audio device --name 3d99d780 --direction input info

Show information about a specific device in the audio device registry:

    $ ffx audio device --token-id 1 info

Play a WAV file directly to device hardware:

    $ cat ~/sine.wav | ffx audio device --name a70075f2 play
    $ ffx audio device --name a70075f2 play --file ~/sine.wav

Record a WAV file directly from device hardware:

    $ ffx audio device --name 3d99d780 record --format 48000,uint8,1ch --duration 1s

Mute the stream of an output device:

    $ ffx audio device --name a70075f2 --direction output mute

Set the gain of an output device to -20 dB:

    $ ffx audio device --name a70075f2 --direction output gain -20

Turn AGC on for an input device:

    $ ffx audio device --name 3d99d780 --direction input agc on
```

#### agc

Request to enable or disable automatic gain control for the stream.


    Usage:  ffx audio device agc enable

| **Options** |   |
|---|---|
| --help | display usage information |

#### gain

Request to set the gain of the stream, in decibels.


    Usage:  ffx audio device gain --gain <gain>

| **Options** |   |
|---|---|
| --help | display usage information |
| --gain | gain, in decibels, to set the stream to. |

#### info

Show information about a specific audio device.


    Usage:  ffx audio device info

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx audio device --type StreamConfig --direction input info
```

#### list

Lists audio devices.


    Usage:  ffx audio device list

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx audio device --type StreamConfig list
```

#### mute

Request to mute a stream.


    Usage:  ffx audio device mute

| **Options** |   |
|---|---|
| --help | display usage information |

#### play

Send audio data directly to device ring buffer.


    Usage:  ffx audio device play [--file <file>] [--element-id <element-id>] [--channels <channels>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --file | file in WAV format containing audio signal. If not specified, ffx command will read from stdin. |
| --element-id | signal processing element ID, for an Endpoint element of type RingBuffer |
| --channels | bitmask of channels to activate (deactivate the others). If not specified, activate all channels present in the playback format |

#### record

Capture audio data directly from ring buffer.


    Usage:  ffx audio device record [--duration <duration>] --format <format> [--element-id <element-id>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --duration | duration of output signal. Examples: 5ms or 3s. If not specified, press ENTER to stop recording. |
| --format | output format (see 'ffx audio help' for more information). |
| --element-id | signal processing element ID, for an Endpoint element of type RingBuffer |

#### reset

Reset device hardware.


    Usage:  ffx audio device reset

| **Options** |   |
|---|---|
| --help | display usage information |

#### set

Set a device property.


    Usage:  ffx audio device set [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [dai-format](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_device_set_dai-format) | Set the DAI format of device or signal processing element. |

##### dai-format

Set the DAI format of device or signal processing element.


    Usage:  ffx audio device set dai-format [--element-id <element-id>] format

| **Options** |   |
|---|---|
| --help | display usage information |
| --element-id | signal processing element ID, for an Endpoint element of type Dai |

**Examples**

```
Set the DAI format for a specific Dai Endpoint signal processing element:

    $ ffx audio device set dai-format --element-id 2 48000,2ch,0x3,pcm_signed,16in16,i2s
```

**Notes**

-

  ```
  This command accepts a DAI format as a comma separated string:
  ```

,,,,,

Where:
: integer frame rate in Hz, e.g. 48000 ch: number of channels, e.g. 2ch : bitmask for channels that are in use, as a hexadecimal number prefixed with 0x, e.g. 0x3 for the first two channels, usually stereo left/right : sample format, one of: pdm, pcm_signed, pcm_unsigned, pcm_float : sample and slot size in bits as: in e.g. 16in32 for 16 valid sample bits in a 32 bit slot : frame format, either: a standard format, one of: none, i2s, stereo_left, stereo_right, tdm1, tdm2, tdm3 or a custom format: custom:;;; where: : justification of samples within a slot, one of: left_justified, right_justified : clocking of data samples, one of: raising_sclk, falling_sclk : number of sclks between the beginning of a frame sync change and audio samples. e.g. 1 for i2s, 0 for left justified : number of sclks that the frame sync is high. e.g. 1

Examples:
48000,2ch,0x3,pcm_signed,16in32,i2s
96000,1ch,0x1,pcm_float,32in32,custom:right_justified;falling_sclk;-1;0

#### start

Start device hardware.


    Usage:  ffx audio device start

| **Options** |   |
|---|---|
| --help | display usage information |

#### stop

Stop device hardware.


    Usage:  ffx audio device stop

| **Options** |   |
|---|---|
| --help | display usage information |

#### unmute

Request to unmute a stream.


    Usage:  ffx audio device unmute

| **Options** |   |
|---|---|
| --help | display usage information |

### gen

Generate an audio signal. Outputs a WAV file written to stdout.


    Usage:  ffx audio gen [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [pink-noise](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_gen_pink-noise) | Generate pink noise. |
| [sawtooth](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_gen_sawtooth) | Generate a sawtooth wave signal. |
| [sine](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_gen_sine) | Generate a sine wave signal. |
| [square](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_gen_square) | Generate a square wave signal. |
| [triangle](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_gen_triangle) | Generate a triangle wave signal. |
| [white-noise](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_audio_gen_white-noise) | Generate white noise. |

**Examples**

```
ffx audio gen sine --duration 5ms --frequency 440 --amplitude 0.5 --format 48000,int16,2ch
```

#### pink-noise

Generate pink noise.


    Usage:  ffx audio gen pink-noise --duration <duration> [--amplitude <amplitude>] --format <format>

| **Options** |   |
|---|---|
| --help | display usage information |
| --duration | duration of output signal. Examples: 5ms or 3s. |
| --amplitude | signal amplitude in range \[0, 1.0\]. Default: 1.0. |
| --format | output format (see 'ffx audio help' for more information). |

#### sawtooth

Generate a sawtooth wave signal.


    Usage:  ffx audio gen sawtooth --duration <duration> --frequency <frequency> [--amplitude <amplitude>] --format <format>

| **Options** |   |
|---|---|
| --help | display usage information |
| --duration | duration of output signal. Examples: 5ms or 3s. |
| --frequency | frequency of output wave in Hz. |
| --amplitude | signal amplitude in range \[0, 1.0\]. Default: 1.0. |
| --format | output format (see 'ffx audio help' for more information). |

#### sine

Generate a sine wave signal.


    Usage:  ffx audio gen sine --duration <duration> --frequency <frequency> [--amplitude <amplitude>] --format <format>

| **Options** |   |
|---|---|
| --help | display usage information |
| --duration | duration of output signal. Examples: 5ms or 3s. |
| --frequency | frequency of output wave in Hz. |
| --amplitude | signal amplitude in range \[0, 1.0\]. Default: 1.0. |
| --format | output format (see 'ffx audio help' for more information). |

#### square

Generate a square wave signal.


    Usage:  ffx audio gen square --duration <duration> --frequency <frequency> [--amplitude <amplitude>] [--duty-cycle <duty-cycle>] --format <format>

| **Options** |   |
|---|---|
| --help | display usage information |
| --duration | duration of output signal. Examples: 5ms or 3s. |
| --frequency | frequency of output wave in Hz. |
| --amplitude | signal amplitude in range \[0, 1.0\]. Default: 1.0. |
| --duty-cycle | duty cycle in range \[0, 1.0\]. Default: 0.5. |
| --format | output format (see 'ffx audio help' for more information). |

#### triangle

Generate a triangle wave signal.


    Usage:  ffx audio gen triangle --duration <duration> --frequency <frequency> [--amplitude <amplitude>] --format <format>

| **Options** |   |
|---|---|
| --help | display usage information |
| --duration | duration of output signal. Examples: 5ms or 3s. |
| --frequency | frequency of output wave in Hz. |
| --amplitude | signal amplitude in range \[0, 1.0\]. Default: 1.0. |
| --format | output format (see 'ffx audio help' for more information). |

#### white-noise

Generate white noise.


    Usage:  ffx audio gen white-noise --duration <duration> [--amplitude <amplitude>] --format <format>

| **Options** |   |
|---|---|
| --help | display usage information |
| --duration | duration of output signal. Examples: 5ms or 3s. |
| --amplitude | signal amplitude in range \[0, 1.0\]. Default: 1.0. |
| --format | output format (see 'ffx audio help' for more information). |

### list-devices

Prints all available audio devices on target


    Usage:  ffx audio list-devices

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
$ ffx audio list-devices
$ ffx audio --machine json list-devices
```

### play

Reads a WAV file from stdin and sends the audio data to audio_core's AudioRenderer API.


    Usage:  ffx audio play [--usage <usage>] [--buffer-size <buffer-size>] [--packet-count <packet-count>] [--gain <gain>] [--mute <mute>] [--clock <clock>] [--file <file>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --usage | purpose of the audio being played. Accepted values: ACCESSIBILITY (and A11Y), BACKGROUND, COMMUNICATION, INTERRUPTION, MEDIA, SYSTEM-AGENT, ULTRASOUND. Default: MEDIA. |
| --buffer-size | buffer size (bytes) to allocate on device VMO. Used to send audio data from ffx tool to AudioRenderer. Defaults to size that holds 1 second of audio data. |
| --packet-count | how many packets to use when sending data to an AudioRenderer. Defaults to 4 packets. |
| --gain | gain (decibels) for the renderer. Default: 0 dB |
| --mute | mute the renderer. Default: false |
| --clock | explicitly set the renderer's reference clock. By default, SetReferenceClock is not called, which leads to a flexible clock. Options include: 'flexible', 'monotonic', and 'custom,,' where rate adjustment and offset are integers. To set offset without rate adjustment, pass 0 in place of rate adjustment. |
| --file | file in WAV format containing audio signal. If not specified, the ffx command will read from stdin. |

**Examples**

```
$ ffx audio gen sine --duration 1s --frequency 440 --amplitude 0.5 --format 48000,int16,2ch | ffx audio play 
$ ffx audio play --file ~/path/to/sine.wav
```

### record

Records audio data from audio_core's AudioCapturer API and outputs a WAV file to stdout.


    Usage:  ffx audio record [--duration <duration>] --format <format> [--usage <usage>] [--buffer-size <buffer-size>] [--clock <clock>] [--gain <gain>] [--mute <mute>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --duration | duration of output signal. Examples: 5ms or 3s. If not specified, press ENTER to stop recording. |
| --format | output format (see 'ffx audio help' for more information). |
| --usage | purpose of the stream being recorded. Accepted values: BACKGROUND, FOREGROUND, SYSTEM-AGENT, COMMUNICATION, ULTRASOUND, or LOOPBACK. Default: COMMUNICATION. |
| --buffer-size | buffer size (bytes) to allocate on device VMO. Used to retrieve audio data from AudioCapturer. Defaults to size that holds 1 second of audio data. |
| --clock | explicitly set the capturer's reference clock. By default, SetReferenceClock is not called, which leads to a flexible clock. Options include: 'flexible', 'monotonic', and 'custom,,' where rate adjustment and offset are integers. To set offset without rate adjustment, pass 0 in place of rate adjustment. |
| --gain | gain (decibels) for the capturer. Default: 0 dB |
| --mute | mute the capturer. Default: false |

**Examples**

```
$ ffx audio record --duration 1s --format 48000,uint8,1ch --usage SYSTEM-AGENT > ~/recording.wav
```

## auth

Generate Fuchsia authorization credentials.


    Usage:  ffx auth [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [generate](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_auth_generate) | Generates authorization credentials for private Fuchsia artifacts |

### generate

Generates authorization credentials for private Fuchsia artifacts


    Usage:  ffx auth generate [--auth <auth>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --auth | choice of authentication flow, defaults to pkce which should be acceptable for most users. |

**Examples**

```
ffx auth generate
```

## bluetooth

Issue a command to Sapphire, the Bluetooth system.


    Usage:  ffx bluetooth [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [connectable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_connectable) | Set this device to be connectable or unconnectable. |
| [controller](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller) | Interact with the Bluetooth controller(s) available to the system. |
| [discoverable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_discoverable) | Set this device to be discoverable or undiscoverable. |
| [discovery](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_discovery) | Start or stop a general discovery procedure. |
| [pairable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_pairable) | Allow pairing with this device. |
| [pandora](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_pandora) | Start/stop a Pandora gRPC test interface server and bluetooth-rootcanal virtual controller. |
| [peer](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_peer) | Show details for a known peer. |

### connectable

Set this device to be connectable or unconnectable.


    Usage:  ffx bluetooth connectable [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_connectable_start) | Make this device connectable. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_connectable_stop) | Revoke this device's connectability. |

**Examples**

```
ffx bluetooth connectable
```

#### start

Make this device connectable.


    Usage:  ffx bluetooth connectable start

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth connectable start
```

#### stop

Revoke this device's connectability.


    Usage:  ffx bluetooth connectable stop

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth connectable stop
```

### controller

Interact with the Bluetooth controller(s) available to the system.


    Usage:  ffx bluetooth controller [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [device-class](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller_device-class) | Interact with the active Bluetooth controller's device class. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller_list) | List information about all Bluetooth controllers available to the system. |
| [local-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller_local-name) | Interact with the active Bluetooth controller's local name. |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller_set) | Set the active Bluetooth controller. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller_show) | Show details about the active Bluetooth controller. |

**Examples**

```
ffx bluetooth controller
```

#### device-class

Interact with the active Bluetooth controller's device class.


    Usage:  ffx bluetooth controller device-class [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller_device-class_set) | Set the active Bluetooth controller's device class. |

**Examples**

```
ffx bluetooth controller device-class
```

##### set

Set the active Bluetooth controller's device class.


    Usage:  ffx bluetooth controller device-class set [--major <major>] [--minor <minor>] [service_classes...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --major | specify the device's major class. Allowed values are "miscellaneous", "computer", "phone", "lan", "audio-video", "peripheral", "imaging", "wearable", "toy", "health", and "uncategorized". Default value is "uncategorized" |
| --minor | specify the device's minor class (an integer between 0 and 63). The meaning of the minor class depends on the major class. Setting this option without specifying a major class will result in an error. Default value is 0. See the Bluetooth Assigned Numbers specification for more information: https://www.bluetooth.com/specifications/assigned-numbers/baseband |

**Examples**

```
To set the device's major class, specify `--major`. To specify the device's minor class, specify `--minor`. To specify the device's service classes, pass any number of them as space-separated arguments. See the Bluetooth Assigned Numbers specification for more information on device class values: https://www.bluetooth.com/specifications/assigned-numbers/baseband.

    $ ffx bluetooth controller device-class set --major computer --minor 1 networking audio
```

#### list

List information about all Bluetooth controllers available to the system.


    Usage:  ffx bluetooth controller list

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth controller list
```

#### local-name

Interact with the active Bluetooth controller's local name.


    Usage:  ffx bluetooth controller local-name [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller_local-name_get) | Get the active Bluetooth controller's local name. |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_controller_local-name_set) | Set the active Bluetooth controller's local name. |

**Examples**

```
ffx bluetooth controller local-name
```

##### get

Get the active Bluetooth controller's local name.


    Usage:  ffx bluetooth controller local-name get

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth controller local-name get 
```

##### set

Set the active Bluetooth controller's local name.


    Usage:  ffx bluetooth controller local-name set name

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth controller local-name set 
```

#### set

Set the active Bluetooth controller.


    Usage:  ffx bluetooth controller set id

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth controller set 
```

#### show

Show details about the active Bluetooth controller.


    Usage:  ffx bluetooth controller show

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth controller show
```

### discoverable

Set this device to be discoverable or undiscoverable.


    Usage:  ffx bluetooth discoverable [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_discoverable_start) | Make this device discoverable. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_discoverable_stop) | Revoke this device's discoverability. |

**Examples**

```
ffx bluetooth discoverable
```

#### start

Make this device discoverable.


    Usage:  ffx bluetooth discoverable start

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth discoverable start
```

#### stop

Revoke this device's discoverability.


    Usage:  ffx bluetooth discoverable stop

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth discoverable stop
```

### discovery

Start or stop a general discovery procedure.


    Usage:  ffx bluetooth discovery [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_discovery_start) | Start a general discovery procedure. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_discovery_stop) | Stop an ongoing general discovery procedure. |

**Examples**

```
ffx bluetooth discovery
```

#### start

Start a general discovery procedure.


    Usage:  ffx bluetooth discovery start

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth discovery start
```

#### stop

Stop an ongoing general discovery procedure.


    Usage:  ffx bluetooth discovery stop

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth discovery stop
```

### pairable

Allow pairing with this device.


    Usage:  ffx bluetooth pairable [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [once](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_pairable_once) | Allow one incoming pairing request. Auto-accepts any valid pairing request and stops accepting additional pairing requests after a successful pairing. If a pairing delegate is already running (e.g. in normal operation of a production device), this operation will fail. Note: Because this command auto-accepts requests, specifying capabilities other than `none` may cause pairing to fail if the negotiated method requires interactive passkey entry or display. |

**Examples**

```
ffx bluetooth pairable
```

#### once

Allow one incoming pairing request. Auto-accepts any valid pairing request and stops accepting additional pairing requests after a successful pairing. If a pairing delegate is already running (e.g. in normal operation of a production device), this operation will fail. Note: Because this command auto-accepts requests, specifying capabilities other than `none` may cause pairing to fail if the negotiated method requires interactive passkey entry or display.


    Usage:  ffx bluetooth pairable once [-i <input-capability>] [-o <output-capability>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -i, --input-capability | set this value based on this device's ability to respond to pairing requests. Allowed values are "none", "confirmation", and "keyboard". These values mean that this device cannot respond, can respond "yes" or "no", or can type a numerical code and send a signal, respectively. Default value is "none" |
| -o, --output-capability | set this value based on this device's ability to display info for pairing requests. Allowed values are "none" and "display". These values mean that this device has no display or has a display that can show a six-digit decimal number, respectively. Default value is "none" |

**Examples**

```
Basic usage:

    $ ffx bluetooth pairable once

To specify this device's input capability, use `--input-capability` or `-i`. To specify this device's output capability, use `--output-capability` or `-o`.

    $ ffx bluetooth pairable once -i none -o none
```

### pandora

Start/stop a Pandora gRPC test interface server and bluetooth-rootcanal virtual controller.


    Usage:  ffx bluetooth pandora [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_pandora_start) | Start Pandora server and bluetooth-rootcanal. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_pandora_stop) | Stop Pandora server and bt-rootcanal if running. |

**Examples**

```
ffx bluetooth pandora start --rootcanal-ip 172.16.243.142
```

#### start

Start Pandora server and bluetooth-rootcanal.


    Usage:  ffx bluetooth pandora start [--grpc-port <grpc-port>] --rootcanal-ip <rootcanal-ip> [--rootcanal-port <rootcanal-port>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --grpc-port | the Fuchsia port on which the Pandora server will listen. Default: 8042. |
| --rootcanal-ip | ip address of the host running the Rootcanal server. |
| --rootcanal-port | port of Rootcanal server. Default: 6402. |

**Examples**

```
ffx bluetooth pandora start --rootcanal-ip 172.16.243.142
```

#### stop

Stop Pandora server and bt-rootcanal if running.


    Usage:  ffx bluetooth pandora stop

| **Options** |   |
|---|---|
| --help | display usage information |

### peer

Show details for a known peer.


    Usage:  ffx bluetooth peer [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [connect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_peer_connect) | Send a connection request to a peer. To start a pairing delegate first, use `--with-pairing`. |
| [disconnect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_peer_disconnect) | Disconnect from a peer. |
| [forget](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_peer_forget) | Delete and disconnect a peer. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_peer_list) | Show all known peers in a summarized view (optionally filtered). |
| [pair](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_peer_pair) | Pair to a peer. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_bluetooth_peer_show) | Show details for a known peer. |

**Examples**

```
ffx bluetooth peer
```

#### connect

Send a connection request to a peer. To start a pairing delegate first, use `--with-pairing`.


    Usage:  ffx bluetooth peer connect [--with-pairing] id_or_addr

| **Options** |   |
|---|---|
| --help | display usage information |
| --with-pairing | start a pairing delegate before connecting. Use this when connecting to unbonded devices to ensure the connection isn't rejected when pairing is required |

**Examples**

```
ffx bluetooth peer connect 
```

#### disconnect

Disconnect from a peer.


    Usage:  ffx bluetooth peer disconnect id_or_addr

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth peer disconnect 
```

#### forget

Delete and disconnect a peer.


    Usage:  ffx bluetooth peer forget id_or_addr

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth peer forget 
```

#### list

Show all known peers in a summarized view (optionally filtered).


    Usage:  ffx bluetooth peer list [--details] [filter]

| **Options** |   |
|---|---|
| --help | display usage information |
| --details | show details for all known peers |

**Examples**

```
ffx bluetooth peer list 
```

#### pair

Pair to a peer.


    Usage:  ffx bluetooth peer pair [--le-security-level <le-security-level>] [--non-bondable] [-t <transport>] id_or_addr

| **Options** |   |
|---|---|
| --help | display usage information |
| --le-security-level | only relevant for LE. Setting this option when transport is "classic" will throw an error. Specify the Security Manager security level to pair with. Allowed values are "encrypted"/"enc" and "authenticated"/"auth". Default value is "authenticated" |
| --non-bondable | prevent the device from forming a bond during pairing. Bonding is enabled by default. If transport is "classic", this option must be absent or an error will be thrown (non bondable mode is not currently supported for the "classic" transport) |
| -t, --transport | specify the technology type to pair over. Allowed values are "lowenergy"/"le", "classic"/"bredr"/"c", and "dualmode"/"both"/"dual"/"dm". Default value is "dualmode" |

**Examples**

```
Basic usage:

    $ ffx bluetooth peer pair 

To set LE security level, specify `--le-security-level`. To disable bonding, use `--non-bondable`. To set the transport technology to use, specify `--transport` or `-t`.

    $ ffx bluetooth peer pair  --le-security-level auth --non-bondable -t dm
```

#### show

Show details for a known peer.


    Usage:  ffx bluetooth peer show id_or_addr

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx bluetooth peer show 
```

## completion

Generate shell completions for ffx


    Usage:  ffx completion shell

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To load completions for zsh, run:
  $ source <(ffx completion zsh)

To load completions for fish, run:
  $ ffx completion fish | source -

To load completions for bash, run:
  $ source <(ffx completion bash)
```

## component

Discover and manage components


    Usage:  ffx component [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [capability](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_capability) | Lists component instances that reference a capability |
| [collection](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_collection) | Manages collections in the component topology |
| [config](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_config) | Manages configuration capability override values for components |
| [copy](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_copy) | copies files to/from directories associated with a component. |
| [create](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_create) | Creates a dynamic component instance, adding it to the collection designated by |
| [debug](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_debug) | Debug a running component with zxdb. |
| [destroy](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_destroy) | Destroys a dynamic component instance, removing it from the collection designated by |
| [doctor](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_doctor) | Perform diagnostic checks on a component at runtime. |
| [explore](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_explore) | Spawns a shell scoped to a component instance. |
| [graph](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_graph) | Outputs a Graphviz dot graph for the components in the component topology. Children of unresolved components are not included in this list. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_list) | Lists components in the component topology. Children of unresolved components are not included in this list. |
| [reload](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_reload) | Recursively stops, unresolves, and starts a component instance, updating the code and topology while preserving resources |
| [resolve](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_resolve) | Resolves a component instance |
| [route](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_route) | Perform capability routing on a component at runtime. |
| [run](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_run) | Creates and starts a component instance in an existing collection |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_show) | Shows detailed information about a component instance |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_start) | Starts a component |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_stop) | Stops a component instance |
| [storage](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_storage) | Manages storage capabilities of components |

### capability

Lists component instances that reference a capability


    Usage:  ffx component capability capability

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To show all components that reference a capability:

    $ ffx component capability fuchsia.net.routes
```

### collection

Manages collections in the component topology


    Usage:  ffx component collection [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_collection_list) | List all collections in the component topology |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_collection_show) | Shows detailed information about a collection in the component topology |

#### list

List all collections in the component topology


    Usage:  ffx component collection list

| **Options** |   |
|---|---|
| --help | display usage information |

#### show

Shows detailed information about a collection in the component topology


    Usage:  ffx component collection show query

| **Options** |   |
|---|---|
| --help | display usage information |

### config

Manages configuration capability override values for components


    Usage:  ffx component config [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_config_list) | Lists structured configuration values for the specified component |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_config_set) | Sets configuration capability override values for the specified component |
| [unset](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_config_unset) | Unsets structured configuration override values for the specified component |

#### list

Lists structured configuration values for the specified component


    Usage:  ffx component config list query

| **Options** |   |
|---|---|
| --help | display usage information |

#### set

Sets configuration capability override values for the specified component


    Usage:  ffx component config set [-r] query [key_values...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --reload | if enabled, component instance will be immediately reloaded so overrides take effect. |

**Examples**

```
To override the configuration fields `bar` and `baz` for the component `/core/ffx-laboratory:foo`:

    $ ffx component config set /core/ffx-laboratory:foo bar=true baz=42

    Use the reload flag to cause the component to reload the component with the override in effect:

    $ ffx component config set --reload /core/ffx-laboratory:foo bar=true

    To override a vector configuration field, use a comma separated list:

    $ ffx component config set /core/ffx-laboratory:foo "some_list=1, 2, 3"
    
```

#### unset

Unsets structured configuration override values for the specified component


    Usage:  ffx component config unset [-r] [query]

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --reload | if enabled, component instance will be immediately reloaded so overrides take effect. |

**Examples**

```
To unset overrides for the component `core/ffx-laboratory:foo`

    $ ffx component config unset `core/ffx-laboratory:foo`

    To unset overrides for all components with overrides:

    $ ffx component config unset
    
```

### copy

copies files to/from directories associated with a component.
Paths may be any combination of local or remote paths.


    Usage:  ffx component copy [-v] [paths...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --verbose | verbose output: outputs a line for each file copied. |

**Examples**

```
To copy from a component to a local path: 
ffx component copy /some/moniker::/path/file.txt /local/file.txt 

To copy from a local path to a component: 
ffx component copy /local/file.txt /some/moniker::/dir/file.txt

To copy between two components: 
ffx component copy /some/moniker::/dir/file.txt /some/moniker::/dir/file.txt

To copy multiple files: 
ffx component copy /some/moniker::/dir/* /some/local/dir
ffx component copy /file/one.txt /file/two.txt ... /some/moniker::/dir/

To copy a file from a component's outgoing directory: 
ffx component copy /some/moniker::out::/path/file.txt /local/file.txt

To copy a file from a component's package directory: 
ffx component copy /some/moniker::pkg::/meta/foo /tmp

```

**Notes**

-

  ```
  To learn more about the command see https://fuchsia.dev/fuchsia-src/development/sdk/ffx/copy-files-to-and-from-a-component
  ```

### create

Creates a dynamic component instance, adding it to the collection designated by


    Usage:  ffx component create [--config <config...>] moniker url

| **Options** |   |
|---|---|
| --help | display usage information |
| --config | provide a configuration override to the component being run. Requires `mutability: \[ "parent" ]` on the configuration field. Specified in the format `KEY=VALUE` where `VALUE` is a JSON string which can be resolved as the correct type of configuration value. |

**Examples**

```
To create a component instance designated by the moniker `/core/ffx-laboratory:foo`:

    $ ffx component create /core/ffx-laboratory:foo fuchsia-pkg://fuchsia.com/hello-world-rust#meta/hello-world-rust.cm
```

**Notes**

-

  ```
  To learn more about running components, see https://fuchsia.dev/go/components/run
  ```

### debug

Debug a running component with zxdb.


    Usage:  ffx component debug query

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To debug the `brightness_manager` component instance, all of the
following commands are valid:

    $ ffx component debug /core/brightness_manager
    $ ffx component debug fuchsia-pkg://fuchsia.com/brightness_manager#meta/brightness_manager.cm
    $ ffx component debug meta/brightness_manager.cm
    $ ffx component debug brightness_manager

If the component is not yet running, consider `ffx component start --debug`
to start the component in the debugger.
```

**Notes**

-

  ```
  This command supports partial matches over the moniker, URL and instance ID
  ```

### destroy

Destroys a dynamic component instance, removing it from the collection designated by


    Usage:  ffx component destroy query

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To destroy a component instance designated by the moniker `/core/ffx-laboratory:foo`:

    $ ffx component destroy /core/ffx-laboratory:foo
```

**Notes**

-

  ```
  To learn more about running components, see https://fuchsia.dev/go/components/run
  ```

### doctor

Perform diagnostic checks on a component at runtime.


    Usage:  ffx component doctor [-p] query

| **Options** |   |
|---|---|
| --help | display usage information |
| -p, --plain | whether or not to display the output without color and wrapping. |

**Examples**

```
To run diagnostics:

$ ffx component doctor /core/network/netstack

This will run checks on the capabilities configuration of the component, checking that all of the
`use` and `expose` capabilities can be routed successfully by the component manager.
```

### explore

Spawns a shell scoped to a component instance.


    Usage:  ffx component explore [--tools <tools...>] [-c <command>] [-l <layout>] query

| **Options** |   |
|---|---|
| --help | display usage information |
| --tools | list of URLs of tools packages to include in the shell environment. the PATH variable will be updated to include binaries from these tools packages. repeat `--tools url` for each package to be included. The path preference is given by command line order. |
| -c, --command | execute a command instead of reading from stdin. the exit code of the command will be forwarded to the host. |
| -l, --layout | changes the namespace layout that is created for the shell. nested: nests all instance directories under subdirs (default) namespace: sets the instance namespace as the root (works better for tools) |

**Examples**

```
To explore the Archivist instance interactively:

> ffx component explore /bootstrap/archivist
$ ls
exposed
ns
out
runtime
svc
$ exit
Connection to terminal closed

To run a command directly from the command line:
> ffx component explore /bootstrap/archivist -c 'printenv'
PATH=/.dash/tools/debug-dash-launcher
PWD=/
```

**Notes**

-

  ```
  When --layout=nested (the default), the environment contains the following
  directories of the explored instance:
  ```
- /ns The namespace of the instance
- /exposed The capabilities exposed by the instance
- /out The outgoing directory of the instance, if it is running
- /runtime The runtime directory of the instance, if it is running

The environment also contains the following directories, irrespective of the explored instance:
\* /.dash User-added and built-in dash tools
\* /svc Protocols required by the dash shell

When --layout=namespace, the contents of the /ns dir above are placed at / with two protocols
(fuchsia.process.Launcher and fuchsia.process.Resolver) overlayed into /svc. In this mode, the
exposed, out, and runtime directories will not be accessible.

With --tools, tools in the specified package will be loaded into /.dash/tools// The path is set so that they can be run by name. The path preference is in the command line order of the --tools arguments, with any built-in tools taking lowest priority.

--tools URLs may be package or binary URLs. If a package URL is given, tool executables are expected
to be in a bin/ dir within the package. If a specific tool URL is given, append the tool path
to the package URL. For example: --tools fuchsia-pkg://fuchsia.com/my_package#bin/my_tool. Note that
naming collisions can occur if multiple packages share a package or binary name. An error,
`NonUniqueBinaryName`, is returned if a binary name collision occurs.

### graph

Outputs a Graphviz dot graph for the components in the component topology. Children of unresolved components are not included in this list.


    Usage:  ffx component graph [-o <only>] [-r <orientation>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --only | filter the instance list by a criteria: ancestor, descendant, relative |
| -r, --orientation | changes the visual orientation of the graph's nodes. Allowed values are "lefttoright"/"lr" and "toptobottom"/"tb". |

**Examples**

```
To graph components in the topology:

    $ ffx component graph

    To graph all running components in the topology:

    $ ffx component graph --only running

    To graph all stopped components in the topology:

    $ ffx component graph --only stopped

    To graph the ancestors of a component named `foo`:

    $ ffx component graph --only ancestor:foo

    To graph the descendants of a component named `foo`:

    $ ffx component graph --only descendant:foo

    To graph both the ancestors and descendants of a component named `foo`:

    $ ffx component graph --only relatives:foo

    To order the graph's nodes from left-to-right (instead of top-to-bottom):

    $ ffx component graph --orientation left_to_right
```

### list

Lists components in the component topology. Children of unresolved components are not included in this list.


    Usage:  ffx component list [-o <only>] [-v]

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --only | filter the instance list by a criteria: running, stopped, ancestors:, descendants:, or relatives: |
| -v, --verbose | show detailed information about each instance |

**Examples**

```
To list components in the topology:

    $ ffx component list

    To list all running components in the topology:

    $ ffx component list --only running

    To list all stopped components in the topology:

    $ ffx component list --only stopped

    To list the ancestors of a component named `foo`:

    $ ffx component list --only ancestor:foo

    To list the descendants of a component named `foo`:

    $ ffx component list --only descendant:foo

    To list both the ancestors and descendants of a component named `foo`:

    $ ffx component list --only relatives:foo
```

### reload

Recursively stops, unresolves, and starts a component instance, updating the code and topology while preserving resources


    Usage:  ffx component reload query

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To reload a component instance designated by the moniker `/core/ffx-laboratory:foo`:

    $ ffx component reload /core/ffx-laboratory:foo
```

**Notes**

-

  ```
  To learn more about running components, see https://fuchsia.dev/go/components/run
  ```

### resolve

Resolves a component instance


    Usage:  ffx component resolve query

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To resolve the component designated by the provided moniker `/core/brightness_manager`:

    $ ffx component resolve /core/brightness_manager
```

### route

Perform capability routing on a component at runtime.


    Usage:  ffx component route target [filter]

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To route capabilities from `font_provider`:

$ ffx component route /core/font_provider

This will perform routing on all the capabilities used or exposed by `font_provider`, and display
information for each route including its status (success or failure) and the identity of the source
component providing the capability.

$ ffx component route fonts.cm

This does the same thing, except with a fuzzy match (on the URL).

$ ffx component route /core/font_provider fuchsia.pkg.FontResolver

This will perform routing on capabilities used or exposed by `font_provider` that match
`fuchsia.pkg.FontResolver`.

$ ffx component route /core/font_provider use:fuchsia.pkg.FontResolver,expose:fuchsia.fonts.Provider

This will perform routing from `font_provider` on used capability `fuchsia.pkg.FontResolver` and
exposed capability `fuchsia.fonts.Provider`.

$ ffx component route /core/font_provider fuchsia.pkg

Fuzzy matching by capability is also supported. This will perform routing from `font_provider` on
any used or exposed capability matching *fuchsia.pkg*.
```

### run

Creates and starts a component instance in an existing collection
within the component topology.


    Usage:  ffx component run [-r] [-f] [--connect-stdio] [--config <config...>] moniker url

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --recreate | destroy and recreate the component instance if it already exists |
| -f, --follow-logs | start printing logs from the started component after it has started |
| --connect-stdio | connect stdin, stdout, and stderr to the component |
| --config | provide a configuration override to the component being run. Requires `mutability: \[ "parent" ]` on the configuration field. Specified in the format `KEY=VALUE` where `VALUE` is a JSON string which can be resolved as the correct type of configuration value. |

**Examples**

```
To create a component instance from the `hello-world-rust` component URL:

    $ ffx component run /core/ffx-laboratory:hello-world fuchsia-pkg://fuchsia.com/hello-world-rust#meta/hello-world-rust.cm
```

**Notes**

- <br />

  ```
  This command is a shorthand for the following:

  $ ffx component create  
  $ ffx component start 
  ```

To learn more about running components, see https://fuchsia.dev/go/components/run

### show

Shows detailed information about a component instance


    Usage:  ffx component show query

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To show information about the `brightness_manager` component instance, all of the
following commands are valid:

    $ ffx component show /core/brightness_manager
    $ ffx component show fuchsia-pkg://fuchsia.com/brightness_manager#meta/brightness_manager.cm
    $ ffx component show meta/brightness_manager.cm
    $ ffx component show brightness_manager
```

**Notes**

-

  ```
  This command supports partial matches over the moniker, URL and instance ID
  ```

### start

Starts a component


    Usage:  ffx component start [--debug] query

| **Options** |   |
|---|---|
| --help | display usage information |
| --debug | start the component in the debugger. To debug a component that is already running, consider `ffx component debug`. |

**Examples**

```
To start the component instance designated by the moniker `/core/brightness_manager`:

    $ ffx component start /core/brightness_manager

The start the brightness manager in the debugger, use the --debug flag:

    $ ffx component start /core/brightness_manager --debug
```

**Notes**

-

  ```
  To learn more about running components, see https://fuchsia.dev/go/components/run
  ```

### stop

Stops a component instance


    Usage:  ffx component stop query

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To stop the component instance designated by the moniker `/core/brightness_manager`:

    $ ffx component stop /core/brightness_manager
```

**Notes**

-

  ```
  To learn more about running components, see https://fuchsia.dev/go/components/run
  ```

### storage

Manages storage capabilities of components


    Usage:  ffx component storage [--provider <provider>] [--capability <capability>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --provider | the moniker of the storage provider component. Defaults to "/core" |
| --capability | the capability name of the storage to use. Examples: "data", "cache", "tmp" Defaults to "data" |

| **Subcommands** |   |
|---|---|
| [copy](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_storage_copy) | Copy files to/from a component's storage. If the file already exists at the destination it is overwritten. |
| [delete](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_storage_delete) | Delete files from a component's storage. |
| [delete-all](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_storage_delete-all) | Delete the contents of the storage for a specific component. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_storage_list) | List the contents of a component's storage. |
| [make-directory](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_component_storage_make-directory) | Create a new directory in a component's storage. If the directory already exists, this operation is a no-op. |

#### copy

Copy files to/from a component's storage. If the file already exists at the destination it is overwritten.


    Usage:  ffx component storage copy source_path destination_path

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To copy `credentials.json` from the current working directory on the host to the `settings` directory of a component's storage:

    $ ffx component storage copy ./credentials.json 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::settings/credentials.json

To copy `credentials.json` from the current working directory on the host to the `settings` directory from a different provider and capability:

    $ ffx component storage --provider /core/test_manager --capability data copy ./credentials.json f1a52f7b4d7081060a3295fd36df7b68fb0518f80aae0eae8a3fc1d55231375f::settings/credentials.json

Note: 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520 is the instance ID of
the component whose storage is being accessed.

To learn about component instance IDs, see https://fuchsia.dev/go/components/instance-id
```

#### delete

Delete files from a component's storage.


    Usage:  ffx component storage delete path

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To delete `credentials.json` from the root directory of a component's persistent storage:

    $ ffx component storage delete 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::credentials.json

Note: 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520 is the instance ID of
the component whose storage is being accessed.

To learn about component instance IDs, see https://fuchsia.dev/go/components/instance-id
```

#### delete-all

Delete the contents of the storage for a specific component.


    Usage:  ffx component storage delete-all moniker

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To delete the contents of the storage for a component with moniker `foo`:

    $ ffx component storage delete-all foo

Note: although unusual, the user may specify internal instance IDs in the moniker such as `foo:0/bar:2`.
```

#### list

List the contents of a component's storage.


    Usage:  ffx component storage list path

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To list the contents of the `settings` directory in a component's storage:

    $ ffx component storage list 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::settings

To list the contents of the root directory of a component's storage:

    $ ffx component storage list 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::/

To list the contents of a directory using a different provider and capability:

    $ ffx component storage --provider /core/test_manager --capability data list f1a52f7b4d7081060a3295fd36df7b68fb0518f80aae0eae8a3fc1d55231375f::/

Note: 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520 is the instance ID of
the component whose storage is being accessed.

To learn about component instance IDs, see https://fuchsia.dev/go/components/instance-id
```

#### make-directory

Create a new directory in a component's storage. If the directory already exists, this operation is a no-op.


    Usage:  ffx component storage make-directory path

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To make a `settings` directory in a storage:

    $ ffx component storage make-directory 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::settings

To make a `settings` directory in a storage from a different provider and capability:

    $ ffx component storage --provider /core/test_manager --capability data make-directory f1a52f7b4d7081060a3295fd36df7b68fb0518f80aae0eae8a3fc1d55231375f::settings

Note: 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520 is the instance ID of
the component whose storage is being accessed.

To learn about component instance IDs, see https://fuchsia.dev/go/components/instance-id
```

## config

View and switch default and user configurations


    Usage:  ffx config [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_add) | add config value the end of an array |
| [analytics](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_analytics) | enable or disable analytics |
| [check-ssh-keys](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_check-ssh-keys) | check the ssh key configuration. |
| [env](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_env) | list environment settings |
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_get) | display config values |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_remove) | remove user level config values |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_set) | set config settings |

### add

add config value the end of an array


    Usage:  ffx config add name value

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

      This will always add to the end of an array.  Adding to a subtree is not supported. If the current value is not an array, it will convert the value to an array.  If you want to insert a value in a different position, consider editing the configuration file directly.  Configuration file locations can be found by running ffx config env get command.

### analytics

enable or disable analytics


    Usage:  ffx config analytics [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [disable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_analytics_disable) | disable analytics |
| [enable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_analytics_enable) | enable basic (redacted) analytics |
| [enable-enhanced](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_analytics_enable-enhanced) | enable enhanced analytics (Googlers only) |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_analytics_show) | show analytics |

#### disable

disable analytics


    Usage:  ffx config analytics disable

| **Options** |   |
|---|---|
| --help | display usage information |

#### enable

enable basic (redacted) analytics


    Usage:  ffx config analytics enable

| **Options** |   |
|---|---|
| --help | display usage information |

#### enable-enhanced

enable enhanced analytics (Googlers only)


    Usage:  ffx config analytics enable-enhanced

| **Options** |   |
|---|---|
| --help | display usage information |

#### show

show analytics


    Usage:  ffx config analytics show

| **Options** |   |
|---|---|
| --help | display usage information |

### check-ssh-keys

check the ssh key configuration.


    Usage:  ffx config check-ssh-keys [--create]

| **Options** |   |
|---|---|
| --help | display usage information |
| --create | create ssh keys if they do not exist |

### env

list environment settings


    Usage:  ffx config env [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_env_get) | list environment for a given level |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_config_env_set) | set environment settings |

#### get

list environment for a given level


    Usage:  ffx config env get [level]

| **Options** |   |
|---|---|
| --help | display usage information |

#### set

set environment settings


    Usage:  ffx config env set [-l <level>] file

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --level | config level. Possible values are "user", "build", "global". Defaults to "user". |

### get

display config values


    Usage:  ffx config get [-p <process>] [-s <select>] [name]

| **Options** |   |
|---|---|
| --help | display usage information |
| -p, --process | how to process results. Possible values are "r/raw", "s/sub/substitute", or "f/file". Defaults to "substitute". Currently only supported if a name is given. The process type "file" returns a scalar value. In the case of the configuration being a list, it is treated as an ordered list of alternatives and takes the first value that exists. |
| -s, --select | how to collect results. Possible values are "first" and "all". Defaults to "first". If the value is "first", the first value found in terms of priority is returned. If the value is "all", all values across all configuration levels are aggregrated and returned. Currently only supported if a name is given. |

| **Errors** |   |
|---|---|
| 2 | No value found |

### remove

remove user level config values


    Usage:  ffx config remove name

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

      This will remove the entire value for the given name.  If the value is a subtree or array, the entire subtree or array will be removed.  If you want to remove a specific value from an array, consider editing the configuration file directly.  Configuration file locations can be found by running ffx config env get command.

### set

set config settings


    Usage:  ffx config set name value

| **Options** |   |
|---|---|
| --help | display usage information |

## coverage

Show coverage from test outputs


    Usage:  ffx coverage --test-output-dir <test-output-dir> --clang-dir <clang-dir> [--symbol-index-json <symbol-index-json>] [--export-html <export-html>] [--export-json <export-json>] [--export-lcov <export-lcov>] [--path-remappings <path-remappings...>] [--compilation-dir <compilation-dir>] [--include-filename-regex <include-filename-regex>] [--ignore-filename-regex <ignore-filename-regex>] [-v] [src_files...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --test-output-dir | path to ffx test output directory |
| --clang-dir | path to clang directory, llvm-profdata and llvm-cov are expected in clang_dir/bin |
| --symbol-index-json | path to symbol index json to load symbol index from |
| --export-html | directory to export HTML reports to |
| --export-json | path to export JSON file to |
| --export-lcov | path to export LCOV file to |
| --path-remappings | a "," remapping of source file paths passed through to llvm-cov |
| --compilation-dir | path to the directory used as a base for relative coverage mapping paths, passed through to llvm-cov |
| --include-filename-regex | regular expression pattern to only include matching source files |
| --ignore-filename-regex | regular expression pattern to skip matching source files |
| -v, --verbose | if set, print verbose information about each command being run, for debugging |

## debug

Start a debugging session.


    Usage:  ffx debug [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [connect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_connect) | start the debugger and connect to the target |
| [core](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_core) | start the debugger and open a minidump |
| [crash](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_crash) | catch a crashing process on the target |
| [fidl](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_fidl) | monitor FIDL traffic on the target |
| [limbo](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_limbo) | control the process limbo on the target |
| [symbol-index](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_symbol-index) | manage symbol sources used by other debug commands |
| [symbolize](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_symbolize) | symbolize backtraces in markup format |

### connect

start the debugger and connect to the target


    Usage:  ffx debug connect [--debugger <debugger>] [--agent-only] [-a <attach...>] [-e <execute...>] [--new-agent] [zxdb_args...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --debugger | start zxdb in another debugger. Currently, the only valid option is "lldb". |
| --agent-only | only start the debug agent but not the zxdb. The path to the UNIX socket will be printed and can be connected via "connect -u" in zxdb shell. |
| -a, --attach | attaches to given processes. The argument will be parsed in the same way as the "attach" command in the console. |
| -e, --execute | execute one zxdb command. Multiple commands will be executed sequentially. |
| --new-agent | always spawn a new DebugAgent instance for this zxdb invocation. |

### core

start the debugger and open a minidump


    Usage:  ffx debug core [--zxdb-args <zxdb-args...>] [minidump]

| **Options** |   |
|---|---|
| --help | display usage information |
| --zxdb-args | extra arguments passed to zxdb. |

### crash

catch a crashing process on the target


    Usage:  ffx debug crash

| **Options** |   |
|---|---|
| --help | display usage information |

### fidl

monitor FIDL traffic on the target


    Usage:  ffx debug fidl [--from <from>] [--to <to>] [--format <format>] [--with <with...>] [--with-process-info] [--stack <stack>] [--syscalls <syscalls...>] [--exclude-syscalls <exclude-syscalls...>] [--messages <messages...>] [--exclude-messages <exclude-messages...>] [--trigger <trigger...>] [--thread <thread...>] [--dump-messages] [--remote-pid <remote-pid...>] [-f <remote-name...>] [--extra-name <extra-name...>] [-c <remote-component...>] [--extra-component <extra-component...>] [--fidl-ir-path <fidl-ir-path...>] [--stay-alive] [extra_args...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --from | specifies the source. Source can be: device: this is the default input. The input comes from the live monitoring of one or several processes. At least one of '--remote-pid', '--remote-name', '--remote-job-id', --'remote-job-name', 'run' must be specified. dump: The input comes from stdin which is the log output of one or several programs. The lines in the log which dump syscalls are decoded and replaced by the decoded version. All other lines are unchanged. : playback. Used to replay a session previously recorded with --to (protobuf format). Path gives the name of the file to read. If path is '-' then the standard input is used. This option must be used at most once. |
| --to | the session is saved to the specified file (binary protobuf format). When a session is saved, you can replay it using "--from ". The raw data is saved. That means that the data saved is independent from what is displayed. |
| --format | the display format for the session dump. The available formats are: pretty: the session is pretty printed (with colors). This is the default output if --with is not used. json: the session is printed using a json format. textproto: the session is printed using a text protobuf format. none: nothing is displayed on the standard output (this option only makes sense when used with `--to` or with `--with`). When there is no output, fidlcat is faster (this is better to monitor real time components). This is the default output when --with is used. |
| --with | specifies an extra summarized output. summary: at the end of the session, a summary of the session is displayed on the standard output. top: at the end of the session, generate a view that groups the output by process, protocol, and method. The groups are sorted by number of events, so groups with more associated events are listed earlier. group-by-thread: for each thread display a short version of all the events. An equal sign followed by a path can be concatanated to the option to output the result in a file instead of the standard output (for example: --with summary=/tmp/x). This option can be used several times. |
| --with-process-info | display the process name, process id and thread id on each line (useful for grep). |
| --stack | define the amount of stack frame to display 0: none (default value) 1: call site (1 to 4 levels) 2: full stack frame (adds some overhead) |
| --syscalls | a regular expression which selects the syscalls to decode and display. This option can be specified multiple times. By default, only zx*channel*.\* syscalls are displayed. To display all the syscalls, use: --syscalls ".\*" |
| --exclude-syscalls | a regular expression which selects the syscalls to not decode and display. This option can be specified multiple times. To be displayed, a syscall must verify --syscalls and not verify --exclude-syscalls. To display all the syscalls but the zx_handle syscalls, use: --syscalls ".*" --exclude-syscalls "zx*handle*.*" |
| --messages | a regular expression which selects the messages to display. To display a message, the method name must satisfy the regexp. This option can be specified multiple times. Message filtering works on the method's fully qualified name. |
| --exclude-messages | a regular expression which selects the messages to not display. If a message method name satisfy the regexp, the message is not displayed (even if it satisfies --messages). This option can be specified multiple times. Message filtering works on the method's fully qualified name. |
| --trigger | start displaying messages and syscalls only when a message for which the method name satisfies the filter is found. This option can be specified multiple times. Message filtering works on the method's fully qualified name. |
| --thread | only display the events for the specified thread. This option can be specified multiple times. By default all the events are displayed. |
| --dump-messages | always does a hexadecimal dump of the messages even if we can decode them. |
| --remote-pid | the koid of the remote process to trace. |
| -f, --remote-name | the of a process. Fidlcat will monitor all existing and future processes whose names includes ( is a substring of the process name). This option can be specified multiple times. When used with --remote-job-id or --remote-job-name, only the processes from the selected jobs are taken into account. |
| --extra-name | like "--remote-name" but for these processes, monitoring starts only when one of the "--remote-name" or "--remote-component" is launched. Also, fidlcat stops when the last "--remote-name" or "--remote-component" stops, even if some "--extra-name" processes are still running. You must specify at least one filter with "--remote-name" or "--remote-component" if you use this option. This option can be specified multiple times. |
| -c, --remote-component | the URL or the moniker of a component for which we want to monitor. All processes running in the component will be monitered. This option can be specified multiple times. |
| --extra-component | like "--remote-component" but for these components, monitoring starts only when one of the "--remote-name" or "--remote-component" is launched. Also, fidlcat stops when the last "--remote-name" or "--remote-component" stops, even if some "--extra-component" are still running. You must specify at least one filter with "--remote-name" or "--remote-component" if you use this option. This option can be specified multiple times. |
| --fidl-ir-path | add the given path as a repository for FIDL IR, in the form of .fidl.json files. Passing a file adds the given file. Passing a directory adds all of the .fidl.json files in that directory and any directory transitively reachable from there. An argfile contains a newline-separated list of .fidl.json files relative to the directory containing the argfile; passing an argfile (starting with the '@' character) adds all files listed in that argfile. This option can be specified multiple times. |
| --stay-alive | don't quit fidlcat when all the monitored processes have ended. This allows to keep monitoring upcoming process. At the end you have to use control-c to quit fidlcat. This is useful when you monitor a process and restart this process."; |

### limbo

control the process limbo on the target


    Usage:  ffx debug limbo [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [disable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_limbo_disable) | disable the process limbo. Will free any pending processes waiting in it. |
| [enable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_limbo_enable) | enable the process limbo. It will now begin to capture crashing processes. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_limbo_list) | lists the processes currently waiting on limbo. The limbo must be active. |
| [release](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_limbo_release) | release a process from limbo. The limbo must be active. |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_limbo_status) | query the status of the process limbo. |

#### disable

disable the process limbo. Will free any pending processes waiting in it.


    Usage:  ffx debug limbo disable

| **Options** |   |
|---|---|
| --help | display usage information |

#### enable

enable the process limbo. It will now begin to capture crashing processes.


    Usage:  ffx debug limbo enable

| **Options** |   |
|---|---|
| --help | display usage information |

#### list

lists the processes currently waiting on limbo. The limbo must be active.


    Usage:  ffx debug limbo list

| **Options** |   |
|---|---|
| --help | display usage information |

#### release

release a process from limbo. The limbo must be active.


    Usage:  ffx debug limbo release pid

| **Options** |   |
|---|---|
| --help | display usage information |

#### status

query the status of the process limbo.


    Usage:  ffx debug limbo status

| **Options** |   |
|---|---|
| --help | display usage information |

### symbol-index

manage symbol sources used by other debug commands


    Usage:  ffx debug symbol-index [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_symbol-index_add) | add a path or url to the symbol index |
| [clean](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_symbol-index_clean) | remove all non-existent paths |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_symbol-index_list) | show the content in symbol index |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_debug_symbol-index_remove) | remove a path from the symbol index |

**Notes**

-

  ```
  symbol-index is a global configuration used by debugging tools to locate
  symbol files.
  ```

#### add

add a path or url to the symbol index


    Usage:  ffx debug symbol-index add [--build-dir <build-dir>] source

| **Options** |   |
|---|---|
| --help | display usage information |
| --build-dir | optional build directory used by zxdb to locate the source code |

**Notes**

-

  ```
  Add a path or a debuginfod server to the symbol index, e.g.,


  - A build-id directory, with an optional build directory.


  - An ids.txt file, with an optional build directory.


  - A file that ends with .symbol-index.json.


  - https://debuginfod.debian.net


  ```

Duplicated adding of the same path or url is a no-op, regardless of the optional
build directory.

#### clean

remove all non-existent paths


    Usage:  ffx debug symbol-index clean

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  Remove all non-existent paths from the symbol index, useful as a garbage
  collection.
  ```

#### list

show the content in symbol index


    Usage:  ffx debug symbol-index list [-a]

| **Options** |   |
|---|---|
| --help | display usage information |
| -a, --aggregated | show the aggregated symbol index |

#### remove

remove a path from the symbol index


    Usage:  ffx debug symbol-index remove source

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  Remove a path or a debuginfod server from the symbol index, e.g.,


  - A build-id directory.


  - An ids.txt file.


  - A file that ends with .symbol-index.json.


  - https://debuginfod.debian.net

  ```

### symbolize

symbolize backtraces in markup format


    Usage:  ffx debug symbolize [--auth] [--no-prettify] [symbolizer_args...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --auth | start the authentication process. |
| --no-prettify | do not prettify the backtraces. |

## devices

List all targets (alias for ffx target list)


    Usage:  ffx devices [-f <format>] [--no-ipv4] [--no-ipv6] [--allow-addrs <allow-addrs>] [--deny-addrs <deny-addrs>] [--no-probe] [--no-mdns] [--no-usb] [--register] [nodename]

| **Options** |   |
|---|---|
| --help | display usage information |
| -f, --format | determines the output format for the list operation |
| --no-ipv4 | do not return IPv4 addresses (deprecated, use --allow-addrs/--deny-addrs) |
| --no-ipv6 | do not return IPv6 addresses (deprecated, use --allow-addrs/--deny-addrs) |
| --allow-addrs | list of address types to show in the output. Value is a comma-separated list of address types. Use 'ipv4', 'ip4', or '4' for IPv4 addresses, 'ipv6', 'ip6' or '6' for IPv6 addresses, 'usb' for USB addresses (e.g. "usb:cid:4"), and 'vsock' for VSOCK addresses (e.g. "vsock:cid:4"). You can also use "all" to accept any addresses, which is the default. --allow-addrs applies before --deny-addrs. |
| --deny-addrs | list of address types to show in the output. Value is a comma-separated list of address types. Use 'ipv4', 'ip4', or '4' for IPv4 addresses, 'ipv6', 'ip6' or '6' for IPv6 addresses, 'usb' for USB addresses (e.g. "usb:cid:4"), and 'vsock' for VSOCK addresses (e.g. "vsock:cid:4"). You can also use "none" to accept any addresses, which is the default. --allow-addrs applies before --deny-addrs. |
| --no-probe | do not connect to targets (direct mode only) |
| --no-mdns | do not do mDNS discovery (direct mode only) |
| --no-usb | do not do USB discovery (direct mode only) |
| --register | register discovered targets in $SHARED_DATA/targets.json (strict mode only) |

**Examples**

```
To list targets in short form:

    $ ffx devices --format s
    fe80::4415:3606:fb52:e2bc%zx-f80ff974f283 pecan-guru-clerk-rhyme

To list targets with only their addresses:

    $ ffx devices --format a
    fe80::4415:3606:fb52:e2bc%zx-f80ff974f283
```

**Notes**

-

  ```
  List all targets.
  ```

In daemon mode (default), this lists targets that the daemon currently has in memory. This includes
manually added targets. The daemon also proactively discovers targets as
they come online. Use `ffx devices` to always get the latest list
of targets. Targets are sorted by name.

In direct mode, this lists targets discovered by searching the local network (mDNS) and USB connections.

The default target is marked with a '\*' next to the node name. The table
has the following columns:

    NAME = The name of the target.
    SERIAL = The serial number of the target.
    TYPE = The product type of the target.
    STATE = The high-level state of the target.
    ADDRS/IP = The discovered and known addresses of the target.
    RCS = Indicates if the Remote Control Service is running on the target.

The NAME column shows the target's advertised name. When the target is
in early boot state such as fastboot, the NAME column may be `<unknown>` with
a STATE being `fastboot` and a SERIAL attribute.

By default, the `list` command outputs in a tabular format. To override
the format, pass `--format` and can take the following options: 'simple\|s'
, 'tabular\|table\|tab\|t', 'addresses\|addrs\|addr\|a', 'name-only\|n', 'json\|JSON\|j' or
'serials'.

By default, Zedboot discovery is disabled. To enable discovery of Zedboot
targets run:

    $ ffx config set discovery.zedboot.enabled true

<br />

| **Errors** |   |
|---|---|
| 2 | If a nodename is supplied, an error code of 2 will be returned if the nodename cannot be resolved |

## doctor

Run common checks for the ffx tool and host environment


    Usage:  ffx doctor [--record] [--no-config] [--retry-delay <retry-delay>] [-v] [--output-dir <output-dir>] [--repair-keys]

| **Options** |   |
|---|---|
| --help | display usage information |
| --record | generates an output zip file with logs |
| --no-config | do not include the ffx configuration file |
| --retry-delay | timeout delay in ms during connection attempt |
| -v, --verbose | verbose, display all steps |
| --output-dir | override the default output directory for doctor records |
| --repair-keys | checks SSH key consistency and repairs them if needed. This may cause any devices to be reflashed. |

**Examples**

```
To run diagnostics:

    $ ffx doctor

To capture the output and additional logs:

    $ ffx doctor --record

By default, this outputs the zip in the current directory. Enabling `--record`
also sets the `--verbose` flag to true.

To override output dir:

    $ ffx doctor --record --output-dir /tmp/ffx
```

**Notes**

-

      The doctor subcommand automatically attempts to repair common target
      interaction issues and provides useful diagnostic information to the user.

The default `retry_delay` is '2000' milliseconds.

## driver

Support driver development workflows


    Usage:  ffx driver [-s] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |

| **Subcommands** |   |
|---|---|
| [composite](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_composite) | Commands to interact with composite node specs. |
| [disable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_disable) | Disables the given driver, and restart its nodes with rematching. |
| [doctor](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_doctor) | Diagnose driver binding issues |
| [dump](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_dump) | Dump device tree |
| [enable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_enable) | Enables the given driver, reverting a disable action. |
| [health-check](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_health-check) | Run an active health check on a bound driver or all bound drivers. |
| [host](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_host) | Commands to interact with driver framework driver hosts. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_list) | List drivers |
| [list-composite-node-specs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_list-composite-node-specs) | List composite node specs. |
| [list-composites](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_list-composites) | List composites |
| [list-devices](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_list-devices) | List devices |
| [list-hosts](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_list-hosts) | List driver hosts and drivers loaded within them |
| [node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_node) | Commands to interact with driver framework nodes. |
| [register](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_register) | Informs the driver manager that a new driver package is available. The driver manager will cache a copy of the driver |
| [restart](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_restart) | Restart all driver hosts containing the driver specified by driver_path. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_show) | Show driver details |
| [static-checks](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_static-checks) | Run static checks against a driver file. |
| [test-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_test-node) | Commands to interact with test nodes. |

### composite

Commands to interact with composite node specs.


    Usage:  ffx driver composite [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_composite_list) | List composite node specs |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_composite_show) | Show detailed information for a composite node spec |

#### list

List composite node specs


    Usage:  ffx driver composite list [-v] [-o <only>] [name]

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --verbose | shows the composite's state and bound driver url if one exists. |
| -o, --only | filter the list by a criteria: bound, unbound, incomplete |

**Examples**

```
To list all composite node specs:

    $ driver composite list

To list only bound composite node specs:

    $ driver composite list --only bound
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

#### show

Show detailed information for a composite node spec


    Usage:  ffx driver composite show query

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To show a composite node spec:

    $ driver composite show my_composite_spec
    
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### disable

Disables the given driver, and restart its nodes with rematching.


    Usage:  ffx driver disable [-s] url

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To disable a driver

    $ driver disable 'fuchsia-pkg://fuchsia.com/example_driver#meta/example_driver.cm'

This can also be used with boot drivers, but keep in mind if the driver being disabled is
critical to the system, the system will become unstable.

    $ driver disable 'fuchsia-boot:///#meta/example_driver.cm'
```

**Notes**

-

  ```
  After this call, nodes that were bound to the requested driver will either have
  another driver (specifically a fallback driver) bound to them, or the node becomes an unbound node
  ready to bind to a driver later, which is generally done with a register call. If there is a
  fallback driver that might take the place of the driver being disabled, and you want to register
  your own driver for the node, the fallback driver should be disabled as well.
  ```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### doctor

Diagnose driver binding issues


    Usage:  ffx driver doctor [--driver <driver>] [--node <node>] [-s] [--composite-node-spec <composite-node-spec>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --driver | URL or a substring of the URL of the driver to diagnose. The command will fail if multiple drivers match. |
| --node | moniker of the node to diagnose. |
| -s, --select | if this exists, the user will be prompted for a component to select. |
| --composite-node-spec | name of the composite node spec to diagnose. |

### dump

Dump device tree


    Usage:  ffx driver dump [-g] [-s] [device]

| **Options** |   |
|---|---|
| --help | display usage information |
| -g, --graph | output device graph in dot language so that it may be viewed |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To dump the device tree:

    $ driver dump
```

```
To dump the subtree of the device tree under a node:

    $ driver dump my-node-name
```

```
To graph device tree:

    $ driver dump --graph | dot -Tpng | display
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### enable

Enables the given driver, reverting a disable action.


    Usage:  ffx driver enable [-s] url

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To enable a driver

    $ driver enable 'fuchsia-pkg://fuchsia.com/example_driver#meta/example_driver.cm'
```

**Notes**

-

  ```
  This is only meant to revert a DisableDriver action. After this call, the driver will be considered for matching to nodes again.
  ```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### health-check

Run an active health check on a bound driver or all bound drivers.


    Usage:  ffx driver health-check [-l <level>] [-a] [moniker]

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --level | health check depth level: ping, fast (default), or deep. |
| -a, --all | run health checks across all bound driver nodes. |

**Examples**

```
To run a fast health check on the display driver:

    $ driver health-check dev/sys/platform/display --level fast
```

**Notes**

-

  ```
  Condition ages (for example, last observed 1.5s ago) are only computed when the tool runs on the target; from a host ffx the raw boot-timeline nanoseconds are printed instead.
  ```

### host

Commands to interact with driver framework driver hosts.


    Usage:  ffx driver host [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_host_list) | List driver hosts and drivers loaded within them |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_host_show) | Show details about a specific drivers host |

#### list

List driver hosts and drivers loaded within them


    Usage:  ffx driver host list

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To list all driver hosts:

    $ driver host list
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

#### show

Show details about a specific drivers host


    Usage:  ffx driver host show [-s] [-r] [-t] pid_or_name

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |
| -r, --runtime | whether to print driver runtime info for the driver host. |
| -t, --stack-trace | whether to print stack traces for the driver host. |

**Examples**

```
To show information about a specific driver host:

    $ driver host show 
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### list

List drivers


    Usage:  ffx driver list [-v] [--loaded] [--running] [-s]

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --verbose | \[Deprecated\] Use `ffx driver show` instead. List all driver properties. |
| --loaded | only list loaded drivers |
| --running | only list drivers that are loaded and currently running |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To list all drivers:

    $ driver list

To list only loaded drivers:

    $ driver list --loaded

To list only loaded and running drivers:

    $ driver list --running
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### list-composite-node-specs

List composite node specs.


    Usage:  ffx driver list-composite-node-specs [-v] [-n <name>] [-s]

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --verbose | list all driver properties. |
| -n, --name | only show the spec with this name. |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To list all composite node specs with properties:

    $ driver list-composite-node-specs -v

To show a specific composite nod spec, specify a `--name` or `-n` for short:

    $ driver list-composite-node-specs -n example_group
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### list-composites

List composites


    Usage:  ffx driver list-composites [-v] [-s]

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --verbose | list all the properties of a composite. |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To list all composites:

    $ driver list-composites -v
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### list-devices

List devices


    Usage:  ffx driver list-devices [-s] [-v] [--exact] [--fail-on-missing] [-u] [device]

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |
| -v, --verbose | list all device properties. |
| --exact | require an exact match on the device filter, instead of a substring match. |
| --fail-on-missing | return a non-zero exit code if no matching devices are found. |
| -u, --unbound | list only unbound nodes. |

**Examples**

```
To list all devices:

    $ driver list-devices -v
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### list-hosts

List driver hosts and drivers loaded within them


    Usage:  ffx driver list-hosts [-s]

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To list all driver hosts:

    $ driver list-hosts
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### node

Commands to interact with driver framework nodes.


    Usage:  ffx driver node [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_node_add) | Add a node with a given bind property |
| [graph](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_node_graph) | Outputs a Graphviz dot graph for the nodes in the node topology. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_node_list) | List nodes in the driver framework |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_node_remove) | Remove a node that was previously added using driver node add. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_node_show) | Show a specific node in the driver framework |

#### add

Add a node with a given bind property


    Usage:  ffx driver node add name property

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To add a node to the driver framework:

    $ driver node add my-node my-key-string=my-value-string
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

#### graph

Outputs a Graphviz dot graph for the nodes in the node topology.


    Usage:  ffx driver node graph [-o <only>] [-r <orientation>] [--services] [--html] [-s <svg>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --only | filter the nodes by a criteria: bound, unbound, ancestors:, primary_ancestors:, descendants:, relatives:, primary_relatives:, siblings:, or primary_siblings:. the primary variants indicate to only traverse primary parents when encountering composites |
| -r, --orientation | changes the visual orientation of the graph's nodes. Allowed values are "lefttoright"/"lr" and "toptobottom"/"tb". |
| --services | whether to show an edge for service routes between nodes. It is highly recommended to narrow down the graph by using filters to just the nodes you need, otherwise the graph is extremely crowded and can cause timeouts on render engines. |
| --html | generate an html to display a generated svg with interactivity like highlighting. Reads from stdin or from the given svg file. |
| -s, --svg | the svg file to read for processing with the html generation. |

**Examples**

```
To graph all nodes:

    $ driver node graph
    
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

#### list

List nodes in the driver framework


    Usage:  ffx driver node list [-v] [-f] [-o <only>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --verbose | shows the node's state and bound driver url if one exists. |
| -f, --fail-on-missing | return a non-zero exit code if no matching devices are found. |
| -o, --only | filter the instance list by a criteria: bound, unbound, ancestors:, primary_ancestors:, descendants:, relatives:, primary_relatives:, siblings:, or primary_siblings:. the primary variants indicate to only traverse primary parents when encountering composites |

**Examples**

```
To list all nodes:

    $ driver node list

To list nodes that match a name or driver:

    $ driver node list my_node
    
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

#### remove

Remove a node that was previously added using driver node add.


    Usage:  ffx driver node remove name

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To remove a node to the driver framework:

    $ driver node remove my-node
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

#### show

Show a specific node in the driver framework


    Usage:  ffx driver node show query

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To show a node:

    $ driver node show dev.sys.my_node
    
```

**Notes**

-

  ```
  This command supports partial matches over the node moniker and driver URL.
  If the query matches more than one node, all matching nodes will be shown.
  ```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### register

Informs the driver manager that a new driver package is available. The driver manager will cache a copy of the driver


    Usage:  ffx driver register [-s] url

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To register a driver

    $ driver register 'fuchsia-pkg://fuchsia.com/example_driver#meta/example_driver.cm'
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver registrar service |

### restart

Restart all driver hosts containing the driver specified by driver_path.


    Usage:  ffx driver restart [-s] driver_path

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To restart a driver:

    $ driver restart fuchsia-boot:///#driver/e1000.so
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver manager service |

### show

Show driver details


    Usage:  ffx driver show [-s] query

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |

**Examples**

```
To show details for a driver:

    $ driver show fuchsia-boot:///dovi#meta/dovi.cm
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

### static-checks

Run static checks against a driver file.


    Usage:  ffx driver static-checks --driver <driver>

| **Options** |   |
|---|---|
| --help | display usage information |
| --driver | the path to the driver's FAR file |

### test-node

Commands to interact with test nodes.


    Usage:  ffx driver test-node [-s] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --select | if this exists, the user will be prompted for a component to select. |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_test-node_add) | Add a test node with a given bind property |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_driver_test-node_remove) | Remove a test node. |

#### add

Add a test node with a given bind property


    Usage:  ffx driver test-node add name property

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To add a test node to the driver framework:

    $ driver test-node add my-node my-key-string=my-value-string
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

#### remove

Remove a test node.


    Usage:  ffx driver test-node remove name

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To remove a test node to the driver framework:

    $ driver test-node remove my-node
```

| **Errors** |   |
|---|---|
| 1 | Failed to connect to the driver development service |

## echo

run echo test against the target


    Usage:  ffx echo [text]

| **Options** |   |
|---|---|
| --help | display usage information |

## efi

Manipulate efi partition


    Usage:  ffx efi [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [create](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_efi_create) | Creates efi partition, copies zircon.bin, bootdata.bin, the efi bootloader file, zedboot.bin, etc... |

### create

Creates efi partition, copies zircon.bin, bootdata.bin, the efi bootloader file, zedboot.bin, etc...


    Usage:  ffx efi create -o <output> [--zircon <zircon>] [--bootdata <bootdata>] [--arch <arch>] [--efi-bootloader <efi-bootloader>] [--zedboot <zedboot>] [--cmdline <cmdline>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | target file/disk to write EFI partition to |
| --zircon | optional path to source file for zircon.bin |
| --bootdata | optional path to source file for bootdata.bin |
| --arch | cpu architecture of the target |
| --efi-bootloader | optional path to source file for the efi bootloader file (e.g. EFI/BOOT/BOOTX64.EFI for X64) |
| --zedboot | optional path to a source file for zedboot.bin |
| --cmdline | optional bootloader cmdline file |

## emu

Start and manage Fuchsia emulators.


    Usage:  ffx emu [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [console](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_console) | \[EXPERIMENTAL\] Connect to a running Fuchsia emulator's console. |
| [input](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input) | Send input events to a running emulator. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_list) | List running Fuchsia emulators. |
| [screenshot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_screenshot) | Take a screenshot of the emulator's primary display. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_show) | Show Fuchsia emulator details. |
| [snapshot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_snapshot) | Save, load, list and delete snapshots of a Fuchsia emulator. |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_start) | Start the Fuchsia emulator. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_stop) | Shut down a running Fuchsia emulator. |

**Notes**

-

  ```
  The emu command is used to start up, manage, and shut down Fuchsia emulators.
  ```

The `start` subcommand launches an emulator according to the configuration in
the Product Bundle. Once one or more emulators are running, you can use the
`list` subcommand to see the name and status of all running emulators, and the
`show` subcommand to get a printout of the configuration for a specific
emulator. When you're done with an emulator, use the `stop` subcommand to
cleanly terminate that emulator.

For more information on the Fuchsia emulator, see the Getting Started page at
https://fuchsia.dev/fuchsia-src/get-started/set_up_femu.

### console

\[EXPERIMENTAL\] Connect to a running Fuchsia emulator's console.


    Usage:  ffx emu console [--console-type <console-type>] [-c] [-m] [-s] [name]

| **Options** |   |
|---|---|
| --help | display usage information |
| --console-type | selector for which console to attach to. Accepted values are: command machine serial |
| -c, --command | attach to the user-interactive command console. Equivalent to "--console-type command". |
| -m, --machine | attach to the machine-readable command console. Equivalent to "--console-type machine". |
| -s, --serial | attach to the Fuchsia serial console. Equivalent to "--console-type serial". |

**Examples**

```
ffx emu console -s
ffx emu console fuchsia-emulator --console-type serial
```

### input

Send input events to a running emulator.


    Usage:  ffx emu input [--name <name>] [--interval <interval>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | name of the emulator instance to send input to, as listed by `ffx emu list`. Defaults to the only running instance. |
| --interval | time in milliseconds between consecutive key combos, characters and scroll ticks. Defaults to 20. |

| **Subcommands** |   |
|---|---|
| [key](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_key) | Press and release keys. |
| [mouse](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_mouse) | Send relative mouse events. |
| [raw](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_raw) | Send raw QMP input events, unchanged, in one QMP command. |
| [text](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_text) | Type printable ASCII text using a US QWERTY layout. |

**Examples**

```
Press and release the 'a' key:
  $ ffx emu input key a

Type text:
  $ ffx emu input text 'Hello, world!'

Move the mouse and click:
  $ ffx emu input mouse move --dx 10 --dy -5
  $ ffx emu input mouse click left

Send raw QMP input events:
  $ ffx emu input raw '\[{{"type":"rel","data":{{"axis":"x","value":7}}}}]'

Target a specific emulator and slow down the steps:
  $ ffx emu input --name fuchsia-emulator --interval 100 key a b c
```

**Notes**

-

      Events are injected into the emulator's virtual input devices through the
      QEMU Machine Protocol (QMP), so they go through the guest's input drivers.
      Use print-input-report on the target to see the resulting reports.
      Only the qemu engine is supported.

Each step, such as one key press or one key release, becomes one input report
in the guest. The exception is `raw` key events given by scancode number:
QEMU sends each of them as its own report.

#### key

Press and release keys.


    Usage:  ffx emu input key [--down <down>] [--up <up>] [--key-duration <key-duration>] [combos...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --down | press the keys of this combo without releasing them. |
| --up | release the keys of this combo, in reverse order, without pressing them. |
| --key-duration | time in milliseconds between the last press and the first release of a combo. Defaults to 20. |

**Examples**

```
  $ ffx emu input key a
  $ ffx emu input key ctrl+alt+delete
  $ ffx emu input key shift+f10 ret
  $ ffx emu input key --down shift
  $ ffx emu input key --up shift
```

**Notes**

-

      Each combo is one or more QEMU QKeyCode names joined with '+'. Names are
      case-sensitive and all lowercase, with no aliases: use a, not A, and ret
      for the Enter/Return key. Common names:
      a..z  0..9  ret  esc  spc  tab  backspace  delete  insert
      shift  shift_r  ctrl  ctrl_r  alt  alt_r  meta_l  meta_r  menu
      up  down  left  right  home  end  pgup  pgdn  caps_lock
      f1..f24  kp_0..kp_9  kp_enter  minus  equal  comma  dot  slash
      All names: https://www.qemu.org/docs/master/interop/qemu-qmp-ref.html#enum-QMP-ui.QKeyCode

The keys of a combo go down in the given order and come back up in reverse
order. --down and --up send only the presses or only the releases. They can't
be combined with positional combos or with each other.

#### mouse

Send relative mouse events.


    Usage:  ffx emu input mouse [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [click](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_mouse_click) | Press and release a mouse button. |
| [down](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_mouse_down) | Press a mouse button without releasing it. |
| [move](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_mouse_move) | Move the mouse by a relative amount, in one report. |
| [scroll](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_mouse_scroll) | Scroll the mouse wheel along one axis. |
| [up](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_input_mouse_up) | Release a mouse button. |

**Notes**

-

      The mouse commands need the virtual device's pointing device to be 'mouse'.
      Check it with ffx emu show.

##### click

Press and release a mouse button.


    Usage:  ffx emu input mouse click [--button-duration <button-duration>] button

| **Options** |   |
|---|---|
| --help | display usage information |
| --button-duration | time in milliseconds the button is held down. Defaults to 20. |

**Examples**

```
  $ ffx emu input mouse click left
  $ ffx emu input mouse click right --button-duration 50
```

##### down

Press a mouse button without releasing it.


    Usage:  ffx emu input mouse down button

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
  $ ffx emu input mouse down left
```

##### move

Move the mouse by a relative amount, in one report.


    Usage:  ffx emu input mouse move [--dx <dx>] [--dy <dy>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --dx | horizontal motion. Positive moves right. Defaults to 0. |
| --dy | vertical motion. Positive moves down. Defaults to 0. |

**Examples**

```
  $ ffx emu input mouse move --dx 10 --dy -5
```

##### scroll

Scroll the mouse wheel along one axis.


    Usage:  ffx emu input mouse scroll [--dy <dy>] [--dx <dx>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --dy | vertical wheel ticks. Positive scrolls up. |
| --dx | horizontal wheel ticks. Positive scrolls right. |

**Examples**

```
  $ ffx emu input mouse scroll --dy 3
  $ ffx emu input mouse scroll --dx -1
```

**Notes**

-

  ```
  Specify exactly one of --dy and --dx. Each tick is one report.
  ```

##### up

Release a mouse button.


    Usage:  ffx emu input mouse up button

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
  $ ffx emu input mouse up left
```

#### raw

Send raw QMP input events, unchanged, in one QMP command.


    Usage:  ffx emu input raw json

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
  $ ffx emu input raw '\[{{"type":"rel","data":{{"axis":"x","value":7}}}}]'
```

**Notes**

-

      The argument is a JSON array of QMP InputEvent objects. It is sent as the
      events of one input-send-event command. See
      https://www.qemu.org/docs/master/interop/qemu-qmp-ref.html#command-QMP-ui.input-send-event

The guest receives the events as one input report, except key events given by
scancode number: QEMU sends each of them as its own report.

#### text

Type printable ASCII text using a US QWERTY layout.


    Usage:  ffx emu input text [--key-duration <key-duration>] text

| **Options** |   |
|---|---|
| --help | display usage information |
| --key-duration | time in milliseconds each key is held down. Defaults to 20. |

**Examples**

```
  $ ffx emu input text 'Hello, world!'
```

**Notes**

-

      Only printable ASCII (0x20-0x7E) is accepted. Shift is added where needed.
      Use ffx emu input key for keys such as ret or tab.

### list

List running Fuchsia emulators.


    Usage:  ffx emu list [-r]

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --only-running | list only the emulators that are currently in the "running" state. |

### screenshot

Take a screenshot of the emulator's primary display.


    Usage:  ffx emu screenshot -o <output> [name]

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | path to save the screenshot. Relative (to the current directory) or absolute paths are both supported. The output will always be in PNG format. |

**Examples**

```
Capture a screenshot from the default emulator:
  $ ffx emu screenshot --output capture.png

Capture and save to a specific directory using the short flag:
  $ ffx emu screenshot -o ./captures/debug.png

Capture and save to an absolute path:
  $ ffx emu screenshot --output /tmp/screenshot.png

Capture from a specific emulator instance:
  $ ffx emu screenshot --output result.png fuchsia-emulator
```

**Notes**

-

  ```
  The screenshot is captured as a PNG file in RGB color space.
  The resolution is the same as the emulator's primary display device.
  ```

This command will fail if:
- The emulator is not in the 'Running' state.
- A virtual display is not enabled in the emulator configuration.
- The output path is a directory.
- The parent directory is not writable.

If the parent directory of the output path does not exist, ffx will
attempt to create it automatically.

### show

Show Fuchsia emulator details.


    Usage:  ffx emu show [--all] [--cmd] [--config] [--device] [--instance] [--net] [name]

| **Options** |   |
|---|---|
| --help | display usage information |
| --all | show all of the available details, which is the default. |
| --cmd | show the command line used to launch the emulator. |
| --config | show the configuration in a format consistent with the 'start' command's --config flag. |
| --device | show the virtual device information used to launch this emulator, in a format consistent with the 'start' command's --device flag. |
| --instance | show the instance information. |
| --net | switch to show network details. |

### snapshot

Save, load, list and delete snapshots of a Fuchsia emulator.


    Usage:  ffx emu snapshot [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [delete](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_snapshot_delete) | Delete snapshots of a Fuchsia emulator. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_snapshot_list) | List the snapshots saved for a Fuchsia emulator. |
| [load](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_snapshot_load) | Restore a running Fuchsia emulator to a previously saved snapshot. |
| [save](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_emu_snapshot_save) | Save a snapshot of a running Fuchsia emulator. |

**Examples**

```
Start an emulator which supports snapshots, and save one once it has booted:
  $ ffx emu start --engine qemu --enable-snapshots
  $ ffx emu snapshot save booted

Roll the running emulator back to that snapshot:
  $ ffx emu snapshot load booted

Stop the emulator, then later resume from the snapshot instead of booting:
  $ ffx emu stop --persist
  $ ffx emu start --from-snapshot booted
```

**Notes**

-

  ```
  A snapshot captures the complete state of a running emulator: the guest's
  memory, CPUs, devices and disk.
  ```

Snapshots are only supported by the "qemu" engine, and only for emulators
which were started with `ffx emu start --enable-snapshots`.

Snapshots are stored in the emulator's disk image, which is part of the
instance's working directory. Use `ffx emu stop --persist` to keep them when
stopping the emulator; otherwise they are deleted along with the rest of the
instance.

#### delete

Delete snapshots of a Fuchsia emulator.


    Usage:  ffx emu snapshot delete [--all] [--name <name>] [snapshot]

| **Options** |   |
|---|---|
| --help | display usage information |
| --all | delete all of the emulator's snapshots. |
| --name | name of the emulator to delete the snapshot of, as specified to the start command. See a list of available instances by running `ffx emu list`. If no name is specified, and only one emulator is running, it will be selected. |

**Examples**

```
  $ ffx emu snapshot delete booted
  $ ffx emu snapshot delete booted --name fuchsia-emulator
  $ ffx emu snapshot delete --all
```

**Notes**

-

  ```
  The emulator does not have to be running. Deleting a snapshot frees the disk
  space which it took up in the emulator's disk image. --all deletes all of the
  emulator's snapshots, and keeps the emulator instance.
  ```

#### list

List the snapshots saved for a Fuchsia emulator.


    Usage:  ffx emu snapshot list [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | name of the emulator to list the snapshots of, as specified to the start command. See a list of available instances by running `ffx emu list`. If no name is specified, and only one emulator is running, it will be selected. |

**Examples**

```
ffx emu snapshot list
ffx emu snapshot list --name fuchsia-emulator
```

**Notes**

-

      The emulator does not have to be running. The snapshots of an emulator which
      was stopped with ffx emu stop --persist are the ones it can be resumed from
      with ffx emu start --from-snapshot <snapshot>.

#### load

Restore a running Fuchsia emulator to a previously saved snapshot.


    Usage:  ffx emu snapshot load [--name <name>] snapshot

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | name of the emulator to restore, as specified to the start command. See a list of available instances by running `ffx emu list`. If no name is specified, and only one emulator is running, it will be selected. |

**Examples**

```
ffx emu snapshot load booted
ffx emu snapshot load booted --name fuchsia-emulator
```

**Notes**

-

  ```
  The current state of the emulator, including any changes made to its disk
  since the snapshot was saved, is discarded.
  ```

Connections which the guest had open do not survive a load: an open
`ffx target ssh` session hangs and has to be started again, while new ffx
commands reconnect to the emulator on their own. The guest's wall clock goes
back to the time at which the snapshot was saved.

To resume a stopped emulator from a snapshot, use
`ffx emu start --from-snapshot <snapshot>` instead.

#### save

Save a snapshot of a running Fuchsia emulator.


    Usage:  ffx emu snapshot save [--name <name>] snapshot

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | name of the emulator to snapshot, as specified to the start command. See a list of available instances by running `ffx emu list`. If no name is specified, and only one emulator is running, it will be selected. |

**Examples**

```
ffx emu snapshot save booted
ffx emu snapshot save booted --name fuchsia-emulator
```

**Notes**

-

  ```
  If a snapshot with the same name already exists, it is replaced.
  ```

The emulator is paused while its state is written to disk, which can take
several seconds.

### start

Start the Fuchsia emulator.


    Usage:  ffx emu start [--accel <accel>] [--config <config>] [--dev-config <dev-config>] [--console] [--debugger] [--smp <smp>] [--device <device>] [--device-list] [--dry-run] [--edit] [--enable-snapshots] [--engine <engine>] [--from-snapshot <from-snapshot>] [--gpu <gpu>] [-H] [--hidpi-scaling <hidpi-scaling>] [-c <kernel-args...>] [-l <log>] [--name <name>] [--no-serial-number] [--net <net>] [--port-map <port-map...>] [--additional-port-forwards <additional-port-forwards...>] [--reuse] [--reuse-with-check] [--stage] [-s <startup-timeout>] [--uefi] [--vbmeta-key <vbmeta-key>] [--vbmeta-key-metadata <vbmeta-key-metadata>] [-V] [product_bundle]

| **Options** |   |
|---|---|
| --help | display usage information |
| --accel | virtualization acceleration. Valid choices are "none" to disable acceleration, "hyper" to use the host's hypervisor interface (KVM on Linux and HVF on MacOS), or "auto" to use the hypervisor if detected. The default value is "auto". |
| --config | specify a configuration file to populate the command line flags for the emulator. Defaults to a Handlebars config specified in the Product Bundle manifest. |
| --dev-config | specify developer config file to append onto the configuration. This is a JSON file with the object structure: {{{{ "args": \[\], "kernel_args": \[\], "env" : {{{{"key": "value"}}}} }}}} |
| --console | launch the emulator in serial console mode. This redirects the virtual serial port to the host's input/output streams, multi-plexed with the QEMU monitor console, then maintains a connection to those streams rather than returning control to the host terminal. This is especially useful when the guest is running without networking enabled. Use the QEMU key sequence `Ctrl-a c` to switch between the serial console and the QEMU monitor console. Note: Control sequences are passed through to the guest system in this mode, so Crtl-c will terminate the guest system's shell, rather than the emulator process itself. If you need to hard-kill the emulator, use the QEMU sequence 'Ctrl-a x' instead. |
| --debugger | pause on launch and wait for a debugger process to attach before resuming. The guest operating system will not begin execution until a debugger, such as gdb or lldb, attaches to the emulator process and signals the emulator to continue. |
| --smp | specify a custom smp (symmetric multiprocessing) configuration. This will override the default values from the product bundle or emulator flags template. Often takes the form of a single integer (e.g. "4") or a more complex string (e.g. "16,threads=2"). |
| --device | the virtual device specification used to configure the emulator. This can be the name of a device listed in the product bundle, or the path to a custom virtual device file. A default for this flag can be set by running `ffx config set emu.device <type>`. If --device is not specified and no default is set, then `ffx emu` will attempt to use the product bundle's recommended device. |
| --device-list | print the list of available virtual devices. |
| --dry-run | sets up the emulation configuration, but doesn't stage files or start the emulator. The command line arguments that the current configuration generates will be printed to stdout for review. |
| --edit | open the user's default editor to modify the command line flags for the emulator. |
| --enable-snapshots | set up the emulator so that snapshots of its state can be saved and loaded with `ffx emu snapshot`. The disk image is staged in the qcow2 format, which can hold snapshots, and the guest is given a CPU model whose state can be saved. Snapshots are only supported by the "qemu" engine, and cannot be used together with `--uefi`. |
| --engine | emulation engine to use for this instance. Allowed values are "femu" which is based on Android Emulator, and "qemu" which uses the version of Qemu packaged with Fuchsia. Default is "femu", which can be overridden by running `ffx config set emu.engine <type>`. Engine defaults are overridden to "qemu" in cases of incompatibility (cross cpu or uefi emulation, or snapshots). |
| --from-snapshot | resume the emulator from the named snapshot, instead of booting it. The snapshot must have been saved with `ffx emu snapshot save` by an emulator with the same name as this instance, which was then stopped with `ffx emu stop --persist`. As with `--reuse`, the stopped instance's image files and configuration are used as they are. |
| --gpu | GPU acceleration mode. Allowed values are "swiftshader_indirect", "lavapipe", "software", "host", or "auto". Default is "swiftshader_indirect". "host" and "auto" are for experimental use only and are not officially supported by the Fuchsia emulator team; graphics artifacts, test failures and emulator crashes may occur. Note: this is unused when using the "qemu" engine type. See https://developer.android.com/studio/run/emulator-acceleration#command-gpu for details on the available options. This can be overridden by running `ffx config set emu.gpu <type>`. |
| -H, --headless | run the emulator without a GUI. The guest system may still initialize graphics drivers, but no graphics interface will be presented to the user. |
| --hidpi-scaling | enable pixel scaling on HiDPI devices. Defaults to true for MacOS, false otherwise. |
| -c, --kernel-args | passes the given string to the emulator executable, appended after all other arguments (since duplicated values favor the later value). This means command-line values will override configuration-provided values for any of these kernel arguments. Can be repeated arbitrarily many times for multiple additional kernel arguments. |
| -l, --log | store the emulator log at the provided filesystem path. By default, all output goes to a log file in the emulator working directory. The path to this file is printed onscreen during start-up. Note that the virtual serial port logs are automatically written to an accompanying file at the same path with a `.serial` suffix (e.g., `<path>.serial`). |
| --name | name of this emulator instance. This is used to identify the instance in other commands and tools. Default is "fuchsia-emulator". This value can also be set via configuration using the key `emu.name`. Note that when using the `--uefi` flag, the visible target name in `ffx target list` will be overwritten by a name "fuchsia-X-Y-Z" where X,Y,Z are derived from the generated mac address for this emulator. This is currently required to support a seamless OTA testing workflow. |
| --no-serial-number | disable serial number generation. Overrides the "emu.serial_number.enabled" config. |
| --net | specify the networking mode for the emulator. Allowed values are "none" which disables networking, "tap" which attaches to a Tun/Tap interface, "user" which sets up mapped ports via SLiRP, and "auto" which will check the host system's capabilities and select "tap" if it is available and "user" otherwise. Default is "auto". This can be overridden by running `ffx config set emu.net <type>`. |
| --port-map | specify a host port mapping for user-networking mode. Ignored in other networking modes. Syntax is "--port-map :". The must be one of those specified in the virtual device specification. This flag may be repeated for multiple port mappings. |
| --additional-port-forwards | specify additional port mappings for user-networking mode. Syntax is "--additional-port-forwards :". This flag may be repeated for multiple port mappings. The guest_port must be non-zero. |
| --reuse | reuse a persistent emulator's (i.e. stopped with `ffx emu stop --persist`) state when starting up. If an emulator with the same name as this instance has been previously started and then stopped without cleanup, this instance will reuse the images from the previous instance. If no previous instance is found, or if the old instance is still running, the new emulator will not attempt to start. |
| --reuse-with-check | reuse a persistent emulator's (i.e. stopped with `ffx emu stop --persist`) state when starting up after version check. If an emulator with the same name as this instance has been previously started and then stopped without cleanup, the zbi and disk volume files are compared against the original. If they match, the instance will reuse the images from the previous instance. If the files do not match, the instance is started using the latest files. If there is no staged instance, the emulator is started using the latest files and the hash information is recorded so this instance can take advantage of this option. |
| --stage | sets up the emulation configuration and stages files, but doesn't start the emulator. The command line arguments that the staged configuration generates will be printed to stdout for review. |
| -s, --startup-timeout | the maximum time (in seconds) to wait on an emulator to boot before returning control to the user. A value of 0 will skip the check entirely. Default is 60 seconds. This can be overridden with `ffx config set emu.start.timeout <seconds>`. |
| --uefi | create and start an emulator with a full GPT disk including UEFI boot environment and all partitions in one flat file. This approximates a physical device as closely as possible. Note that this is currently only enabled for x64 and arm64 targets. RISC-V is unsupported. Note that for full GPT disks, it is also required to provide the `--vbmeta-key` and `--vbmeta-key-metadata` arguments, otherwise the resulting GPT image will not be able to boot into its A and B slots. |
| --vbmeta-key | path to the key (a PEM file) that should be used to sign a vbmeta file for the ZBI after embedding the SSH keys, for example: https://cs.opensource.google/fuchsia/fuchsia/+/main:boards/x64/BUILD.gn;l=44-46;drc=04892e7f8875e2d16c3fcda89bc462dc6b0f35f8) Note that this is only required when using `--uefi`. Also, when an emulator is `--reuse`d after it was stopped with the `--persist` flag, this argument is not necessary as the previously created images will be used. |
| --vbmeta-key-metadata | path to the key metadata (a binary file accompanying the PEM, for example https://cs.opensource.google/fuchsia/fuchsia/+/main:boards/x64/BUILD.gn;l=44-46;drc=04892e7f8875e2d16c3fcda89bc462dc6b0f35f8) that should be used to sign a vbmeta file for the ZBI after embedding the SSH keys. Note that this is only required when using `--uefi`. Also, when an emulator is `--reuse`d after it was stopped with the `--persist` flag, this argument is not necessary as the |
| -V, --verbose | enables extra logging for debugging. |

**Examples**

```
ffx emu start
```

**Notes**

-

      The start subcommand is the starting point for all emulator interactions.
      The name provided here will be used for all later interactions to indicate
      which emulator to target. Emulator names must be unique.

The start command will compile all of the necessary configuration for an
emulator, launch the emulator, and then store the configuration on disk for
future reference. The configuration comes from the Product Bundle, which
includes a virtual device specification and a start-up flag template. See
https://fuchsia.dev/fuchsia-src/contribute/governance/rfcs/0100_product_metadata
for more information.

Unless run in console mode, the emulator runs as a background daemon and must
be terminated by `ffx emu stop`.

### stop

Shut down a running Fuchsia emulator.


    Usage:  ffx emu stop [--all] [-p] [name]

| **Options** |   |
|---|---|
| --help | display usage information |
| --all | shut down and clean up all emulator instances running on the device. |
| -p, --persist | don't remove the state directory on stop, just terminate the emulator. |

**Examples**

```
ffx emu stop
ffx emu stop --all
ffx emu stop fuchsia-emulator --persist
```

**Notes**

-

  ```
  By default, the stop command will remove an emulator's on-disk
  working directory, which contains emulator state, staged image files, etc.
  ```

Use the --persist flag if you need to leave the working directory intact while
shutting down the emulator, for debugging or troubleshooting purposes. The
working directory will be left in place, and the emulator will be marked
\[Inactive\] in `ffx emu list` results until stop is called for that instance
without the --persist flag.

## forward

Forward connections between host and target device.


    Usage:  ffx forward [-q] [-i <ui-interval>] [--once] [spec...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -q, --quiet | omits all interactive terminal output |
| -i, --ui-interval | UI refresh interval in ms |
| --once | exit upon failure to communicate with the target If specified, errors cause forward to exit. Otherwise, the default behavior is to keep attempting target connection. |

**Examples**

```
forward '8080=>8081' # forward TCP host port 8080 to target port 8081
forward 'tcp:\[::1]:8080<=80' # forward TCP target port 80 to host port 8080 over IPv6
```

## fuzz

Start and manage fuzzers.


    Usage:  ffx fuzz [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_add) | Adds an input to a fuzzer's corpus. |
| [cleanse](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_cleanse) | Clears extraneous bytes from an error input. |
| [fetch](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_fetch) | Retrieves the attached fuzzer's corpus. |
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_get) | Gets option(s) from a fuzzer. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_list) | Lists available fuzzers. |
| [merge](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_merge) | Compacts the attached fuzzer's corpus. |
| [minimize](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_minimize) | Reduce the size of an error input. |
| [run](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_run) | Generates inputs and fuzz the target. |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_set) | Sets options on a fuzzer. |
| [shell](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_shell) | Starts an interactive fuzzing session. |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_status) | Gets a fuzzer's execution status. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_stop) | Stops a fuzzer. |
| [try](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_fuzz_try) | Tests a specific input with a fuzzer. |

### add

Adds an input to a fuzzer's corpus.


    Usage:  ffx fuzz add [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] [-s] url input

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |
| -s, --seed | add to the seed corpus; default is to add to live corpus |

### cleanse

Clears extraneous bytes from an error input.


    Usage:  ffx fuzz cleanse [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] url input

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |

### fetch

Retrieves the attached fuzzer's corpus.


    Usage:  ffx fuzz fetch [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] [-s] url

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |
| -s, --seed | fetch the seed corpus; default is to fetch the live corpus |

### get

Gets option(s) from a fuzzer.


    Usage:  ffx fuzz get [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] url [name]

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |

### list

Lists available fuzzers.


    Usage:  ffx fuzz list [-j <json-file>] [-p <pattern>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -j, --json-file | path to JSON file describing fuzzers; looks for tests.json under $FUCHSIA_DIR by default |
| -p, --pattern | list all fuzzers matching shell-style glob pattern; default is to list all fuzzers |

### merge

Compacts the attached fuzzer's corpus.


    Usage:  ffx fuzz merge [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] url

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |

### minimize

Reduce the size of an error input.


    Usage:  ffx fuzz minimize [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] [-r <runs>] [-t <time>] url input

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |
| -r, --runs | convenient shortcut for "set runs " |
| -t, --time | convenient shortcut for "set max_total_time " |

### run

Generates inputs and fuzz the target.


    Usage:  ffx fuzz run [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] [-r <runs>] [-t <time>] url

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |
| -r, --runs | convenient shortcut for "set runs " |
| -t, --time | convenient shortcut for "set max_total_time " |

### set

Sets options on a fuzzer.


    Usage:  ffx fuzz set [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] url name value

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |

### shell

Starts an interactive fuzzing session.


    Usage:  ffx fuzz shell [-j <json-file>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -j, --json-file | path to JSON file describing fuzzers; looks for tests.json under $FUCHSIA_DIR by default |

### status

Gets a fuzzer's execution status.


    Usage:  ffx fuzz status [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] url

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |

### stop

Stops a fuzzer.


    Usage:  ffx fuzz stop [-q] [url]

| **Options** |   |
|---|---|
| --help | display usage information |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |

### try

Tests a specific input with a fuzzer.


    Usage:  ffx fuzz try [-o <output>] [-q] [--no-stdout] [--no-stderr] [--no-syslog] url input

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | where to send fuzzer logs and artifacts; default is stdout and the current directory |
| -q, --quiet | if present, suppress non-error output from the ffx tool itself |
| --no-stdout | disables forwarding standard output from the fuzzer |
| --no-stderr | disables forwarding standard error from the fuzzer |
| --no-syslog | disables forwarding system logs from the fuzzer |

## gce

Start and manage Fuchsia instances directly on Google Compute Engine (GCE).


    Usage:  ffx gce [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_gce_list) | List Fuchsia GCE virtual machine instances. |
| [serial](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_gce_serial) | Read or stream serial port output from a Fuchsia GCE virtual machine. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_gce_show) | Show detailed information about a Fuchsia GCE virtual machine instance. |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_gce_start) | Start a Fuchsia GCE virtual machine instance. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_gce_stop) | Stop or delete a running Fuchsia GCE virtual machine instance. |

**Notes**

-

      The gce command is used to start up, manage, and shut down Fuchsia instances running natively as GCE guest virtual machines without QEMU or nested virtualization.

### list

List Fuchsia GCE virtual machine instances.


    Usage:  ffx gce list [--project <project>] [--zone <zone>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --project | GCP Project ID. If unset, uses default from config. |
| --zone | GCE zone. If unset, uses default from config. |

### serial

Read or stream serial port output from a Fuchsia GCE virtual machine.


    Usage:  ffx gce serial [--project <project>] [--zone <zone>] [--port <port>] [--follow] [--start <start>] name

| **Options** |   |
|---|---|
| --help | display usage information |
| --project | GCP Project ID. If unset, uses default from config. |
| --zone | GCE zone. If unset, uses default from config. |
| --port | port number. Defaults to 1 (UART COM1). |
| --follow | follow/stream output continuously as it becomes available. |
| --start | start byte offset for reading output. |

### show

Show detailed information about a Fuchsia GCE virtual machine instance.


    Usage:  ffx gce show [--project <project>] [--zone <zone>] name

| **Options** |   |
|---|---|
| --help | display usage information |
| --project | GCP Project ID. If unset, uses default from config. |
| --zone | GCE zone. If unset, uses default from config. |

### start

Start a Fuchsia GCE virtual machine instance.


    Usage:  ffx gce start [--name <name>] [--project <project>] [--zone <zone>] [--machine-type <machine-type>] [--bucket <bucket>] [--serial] [--reuse-image] [--vbmeta-key <vbmeta-key>] [--vbmeta-metadata <vbmeta-metadata>] [product_bundle]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | name of the instance. If unset, a random instance name ("fuchsia-gce-") is generated. |
| --project | GCP Project ID. If unset, uses default from config. |
| --zone | GCE zone. If unset, uses default from config. |
| --machine-type | GCE machine type. Defaults to "n2-standard-4" for x64 and "t2a-standard-4" for arm64. |
| --bucket | GCS bucket used to store disk images. Defaults to "-fuchsia-images". |
| --serial | attach to the VM serial port output after starting. |
| --reuse-image | reuse an existing GCE custom image if one with the matching bundle hash already exists. |
| --vbmeta-key | optional path to VBMeta signing key (.pem). |
| --vbmeta-metadata | optional path to VBMeta key metadata (.bin). |

**Examples**

```
To start a Fuchsia instance on GCE:

    $ ffx gce start
```

### stop

Stop or delete a running Fuchsia GCE virtual machine instance.


    Usage:  ffx gce stop [--project <project>] [--zone <zone>] [--keep] name

| **Options** |   |
|---|---|
| --help | display usage information |
| --project | GCP Project ID. If unset, uses default from config. |
| --zone | GCE zone. If unset, uses default from config. |
| --keep | if true, only stop the instance without deleting it. |

## inspect

Query data exposed by components via the Inspect API.


    Usage:  ffx inspect [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [apply-selectors](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_inspect_apply-selectors) | Apply selectors from a file interactively. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_inspect_list) | Lists all components (relative to the scope where the archivist receives events from) of components that expose inspect. |
| [list-accessors](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_inspect_list-accessors) | Lists all available ArchiveAccessor in the system and their selector for use in "accessor" arguments in other sub-commands. |
| [selectors](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_inspect_selectors) | Lists all available selectors for the given input of component queries or partial selectors. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_inspect_show) | Prints the inspect hierarchies that match the given selectors. See https://fuchsia.dev/fuchsia-src/development/diagnostics/inspect#userspace_tools for more. |

**Examples**

````
If you wish to see the JSON format of Inspect, you must pass `--machine json` to the `ffx` command. 
For example to see the Inspect JSON of all components running in the system, run: 

```
ffx --machine json inspect show
```
````

### apply-selectors

Apply selectors from a file interactively.


    Usage:  ffx inspect apply-selectors [--snapshot-file <snapshot-file>] [--moniker <moniker>] [--accessor-path <accessor-path>] selector_file

| **Options** |   |
|---|---|
| --help | display usage information |
| --snapshot-file | path to the inspect json file to read this file contains inspect.json data from snapshot.zip. If not provided, DiagnosticsProvider will be used to get inspect data. |
| --moniker | moniker of the component to apply the command. |
| --accessor-path | the path from where to get the ArchiveAccessor connection. If the given path is a directory, the command will look for a `fuchsia.diagnostics.ArchiveAccessor` service file. If the given path is a service file, the command will attempt to connect to it as an ArchiveAccessor. |

### list

Lists all components (relative to the scope where the archivist receives events from) of components that expose inspect.


    Usage:  ffx inspect list [--component <component>] [--with-url] [--accessor <accessor>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --component | a fuzzy-search query. May include URL, moniker, or manifest fragments. a fauzzy-search query for the component we are interested in. May include URL, moniker, or manifest fragments. If this is provided, the output will only contain monikers for components that matched the query. |
| --with-url | also print the URL of the component. |
| --accessor | a selector specifying what `fuchsia.diagnostics.ArchiveAccessor` to connect to. The selector will be in the form of: :fuchsia.diagnostics.ArchiveAccessor(.pipeline_name)? Typically this is the output of `iquery list-accessors`. For example: `bootstrap/archivist:fuchsia.diagnostics.ArchiveAccessor.feedback` means that the command will connect to the `ArchiveAccecssor` filtered by the feedback pipeline exposed by `bootstrap/archivist`. |

### list-accessors

Lists all available ArchiveAccessor in the system and their selector for use in "accessor" arguments in other sub-commands.


    Usage:  ffx inspect list-accessors

| **Options** |   |
|---|---|
| --help | display usage information |

### selectors

Lists all available selectors for the given input of component queries or partial selectors.


    Usage:  ffx inspect selectors [--data <data...>] [--accessor <accessor>] [selectors...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --data | tree selectors to splice onto a component query specified as a positional argument For example, `show foo.cm --data root:bar` becomes the selector `path/to/foo:root:bar`. |
| --accessor | a string specifying what `fuchsia.diagnostics.ArchiveAccessor` to connect to. This can be copied from the output of `ffx inspect list-accessors`. The selector will be in the form of: :fuchsia.diagnostics.ArchiveAccessor.pipeline_name |

### show

Prints the inspect hierarchies that match the given selectors. See https://fuchsia.dev/fuchsia-src/development/diagnostics/inspect#userspace_tools for more.


    Usage:  ffx inspect show [--data <data...>] [--accessor <accessor>] [--name <name>] [selectors...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --data | tree selectors to splice onto a component query specified as a positional argument For example, `show foo.cm --data root:bar` becomes the selector `path/to/foo:root:bar`. |
| --accessor | string specifying what `fuchsia.diagnostics.ArchiveAccessor` to connect to. This can be copied from the output of `ffx inspect list-accessors`. The selector will be in the form of: :fuchsia.diagnostics.ArchiveAccessorName |
| --name | specifies a tree published by a component by name. If a selector is also provided, the specified name will be added to the selector. |

## log

Display logs from a target device


    Usage:  ffx log [--set-severity <set-severity...>] [--filter <filter...>] [--moniker <moniker...>] [--component <component...>] [--exclude <exclude...>] [--exclude-regex <exclude-regex...>] [--exclude-regex-file <exclude-regex-file>] [--tag <tag...>] [--exclude-tags <exclude-tags...>] [--severity <severity>] [--kernel] [--since <since>] [--since-boot <since-boot>] [--until <until>] [--until-boot <until-boot>] [--hide-tags] [--hide-file] [--no-color] [--case-sensitive] [--show-metadata] [--show-full-moniker] [--prefer-url-component-name] [--hide-moniker] [--clock <clock>] [--symbolize <symbolize>] [--pid <pid>] [--tid <tid>] [--force-set-severity] [--disable-reconnect] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --set-severity | configure the log settings on the target device for components matching the given selector. This modifies the minimum log severity level emitted by components during the logging session. Specify using the format #, with level as one of FATAL |
| --filter | filter for a string in either the message, component or url. May be repeated. |
| --moniker | DEPRECATED: use --component |
| --component | fuzzy search for a component by moniker or url. May be repeated. |
| --exclude | exclude a string in either the message, component or url. May be repeated. |
| --exclude-regex | exclude logs matching a regular expression. May be repeated. |
| --exclude-regex-file | path to a file containing regular expressions, one per line, to exclude. |
| --tag | filter for only logs with a given tag. May be repeated. |
| --exclude-tags | exclude logs with a given tag. May be repeated. |
| --severity | set the minimum severity. Accepted values (from lower to higher) are: trace, debug, info, warn (or warning), error, fatal. This field is case insensitive. |
| --kernel | outputs only kernel logs, unless combined with --component. |
| --since | show only logs after a certain time (exclusive) |
| --since-boot | show only logs after a certain time (as a boot timestamp: seconds from the target's boot time). |
| --until | show only logs until a certain time (exclusive) |
| --until-boot | show only logs until a certain time (as a boot timestamp: seconds since the target's boot time). |
| --hide-tags | hide the tag field from output (does not exclude any log messages) |
| --hide-file | hide the file and line number field from output (does not exclude any log messages) |
| --no-color | disable coloring logs according to severity. Note that you can permanently disable this with `ffx config set log_cmd.color false` |
| --case-sensitive | if enabled, text filtering options are case-sensitive this applies to --filter, --exclude, --tag, and --exclude-tags. |
| --show-metadata | shows process-id and thread-id in log output |
| --show-full-moniker | shows the full moniker in log output. By default this is false and only the last segment of the moniker is printed. |
| --prefer-url-component-name | if enabled, prefer using the component URL for the component name over the moniker. |
| --hide-moniker | hide the moniker field from output (does not exclude any log messages) |
| --clock | how to display log timestamps. Options are "utc", "local", or "boot" (i.e. nanos since target boot). Default is boot. |
| --symbolize | configure symbolization options. Valid options are: - pretty (default): pretty concise symbolization - off: disables all symbolization - classic: traditional, non-prettified symbolization |
| --pid | filters by pid |
| --tid | filters by tid |
| --force-set-severity | if enabled, selectors will be passed directly to Archivist without any filtering. If disabled and no matching components are found, the user will be prompted to either enable this or be given a list of selectors to choose from. This applies to both --set-severity and the set-severity subcommand. |
| --disable-reconnect | disable automatic reconnect |

| **Subcommands** |   |
|---|---|
| [dump](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_log_dump) | Dumps all logs from a given target's session. |
| [set-severity](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_log_set-severity) | Sets the severity, but doesn't view any logs. |
| [watch](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_log_watch) | Watches for and prints logs from a target. Default if no sub-command is specified. |

**Examples**

```
Dump the most recent logs and stream new ones as they happen:
  $ ffx log

Stream new logs starting from the current time, filtering for severity of at least "WARN":
  $ ffx log --severity warn --since now

Stream logs where the source moniker, component url and message do not include "sys":
  $ ffx log --exclude sys

Stream ERROR logs with source moniker, component url or message containing either
"netstack" or "remote-control.cm", but not containing "sys":
  $ ffx log --severity error --filter netstack --filter remote-control.cm --exclude sys

Dump all available logs where the source moniker, component url, or message contains
"remote-control":
  $ ffx log --filter remote-control dump

Dump all logs from the last 30 minutes logged before 5 minutes ago:
  $ ffx log --since "30m ago" --until "5m ago" dump

Enable DEBUG logs from the "core/audio" component while logs are streaming:
  $ ffx log --set-severity core/audio#DEBUG
```

**Notes**

-

  ```
  Logs are retrieved from the target at the moment this command is called.
  ```

You may see some additional information attached to the log line:

- `dropped=N`: this means that N logs attributed to the component were dropped when the component
  wrote to the log socket. This can happen when archivist cannot keep up with the rate of logs being
  emitted by the component and the component filled the log socket buffer in the kernel.

- `rolled=N`: this means that N logs rolled out from the archivist buffer and ffx never saw them.
  This can happen when more logs are being ingested by the archivist across all components and the
  ffx couldn't retrieve them fast enough.

Symbolization is performed in the background using the symbolizer host tool. You can pass
additional arguments to the symbolizer tool (for example, to add a remote symbol server) using:
$ ffx config set proactive_log.symbolize.extra_args "--symbol-server gs://some-url/path --symbol-server gs://some-other-url/path ..."

To learn more about configuring the log viewer, visit https://fuchsia.dev/fuchsia-src/development/tools/ffx/commands/log

### dump

Dumps all logs from a given target's session.


    Usage:  ffx log dump [--tail <tail>] [--filter <filter...>] [--moniker <moniker...>] [--component <component...>] [--exclude <exclude...>] [--exclude-regex <exclude-regex...>] [--exclude-regex-file <exclude-regex-file>] [--tag <tag...>] [--exclude-tags <exclude-tags...>] [--severity <severity>] [--kernel] [--since <since>] [--since-boot <since-boot>] [--until <until>] [--until-boot <until-boot>] [--hide-tags] [--hide-file] [--no-color] [--case-sensitive] [--show-metadata] [--show-full-moniker] [--prefer-url-component-name] [--hide-moniker] [--clock <clock>] [--symbolize <symbolize>] [--pid <pid>] [--tid <tid>] [--force-set-severity] [--disable-reconnect]

| **Options** |   |
|---|---|
| --help | display usage information |
| --tail | return only the last N log lines. |
| --filter | filter for a string in either the message, component or url. May be repeated. |
| --moniker | DEPRECATED: use --component |
| --component | fuzzy search for a component by moniker or url. May be repeated. |
| --exclude | exclude a string in either the message, component or url. May be repeated. |
| --exclude-regex | exclude logs matching a regular expression. May be repeated. |
| --exclude-regex-file | path to a file containing regular expressions, one per line, to exclude. |
| --tag | filter for only logs with a given tag. May be repeated. |
| --exclude-tags | exclude logs with a given tag. May be repeated. |
| --severity | set the minimum severity. Accepted values (from lower to higher) are: trace, debug, info, warn (or warning), error, fatal. This field is case insensitive. |
| --kernel | outputs only kernel logs, unless combined with --component. |
| --since | show only logs after a certain time (exclusive) |
| --since-boot | show only logs after a certain time (as a boot timestamp: seconds from the target's boot time). |
| --until | show only logs until a certain time (exclusive) |
| --until-boot | show only logs until a certain time (as a boot timestamp: seconds since the target's boot time). |
| --hide-tags | hide the tag field from output (does not exclude any log messages) |
| --hide-file | hide the file and line number field from output (does not exclude any log messages) |
| --no-color | disable coloring logs according to severity. Note that you can permanently disable this with `ffx config set log_cmd.color false` |
| --case-sensitive | if enabled, text filtering options are case-sensitive this applies to --filter, --exclude, --tag, and --exclude-tags. |
| --show-metadata | shows process-id and thread-id in log output |
| --show-full-moniker | shows the full moniker in log output. By default this is false and only the last segment of the moniker is printed. |
| --prefer-url-component-name | if enabled, prefer using the component URL for the component name over the moniker. |
| --hide-moniker | hide the moniker field from output (does not exclude any log messages) |
| --clock | how to display log timestamps. Options are "utc", "local", or "boot" (i.e. nanos since target boot). Default is boot. |
| --symbolize | configure symbolization options. Valid options are: - pretty (default): pretty concise symbolization - off: disables all symbolization - classic: traditional, non-prettified symbolization |
| --pid | filters by pid |
| --tid | filters by tid |
| --force-set-severity | if enabled, selectors will be passed directly to Archivist without any filtering. If disabled and no matching components are found, the user will be prompted to either enable this or be given a list of selectors to choose from. This applies to both --set-severity and the set-severity subcommand. |
| --disable-reconnect | disable automatic reconnect |

### set-severity

Sets the severity, but doesn't view any logs.


    Usage:  ffx log set-severity [--no-persist] [--force] [interest_selector...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --no-persist | if true, doesn't persist the interest setting and blocks forever, keeping the connection open. Interest settings will be reset when the command exits. |
| --force | if enabled, selectors will be passed directly to Archivist without any filtering. If disabled and no matching components are found, the user will be prompted to either enable this or be given a list of selectors to choose from. |

### watch

Watches for and prints logs from a target. Default if no sub-command is specified.


    Usage:  ffx log watch [--filter <filter...>] [--moniker <moniker...>] [--component <component...>] [--exclude <exclude...>] [--exclude-regex <exclude-regex...>] [--exclude-regex-file <exclude-regex-file>] [--tag <tag...>] [--exclude-tags <exclude-tags...>] [--severity <severity>] [--kernel] [--since <since>] [--since-boot <since-boot>] [--until <until>] [--until-boot <until-boot>] [--hide-tags] [--hide-file] [--no-color] [--case-sensitive] [--show-metadata] [--show-full-moniker] [--prefer-url-component-name] [--hide-moniker] [--clock <clock>] [--symbolize <symbolize>] [--pid <pid>] [--tid <tid>] [--force-set-severity] [--disable-reconnect]

| **Options** |   |
|---|---|
| --help | display usage information |
| --filter | filter for a string in either the message, component or url. May be repeated. |
| --moniker | DEPRECATED: use --component |
| --component | fuzzy search for a component by moniker or url. May be repeated. |
| --exclude | exclude a string in either the message, component or url. May be repeated. |
| --exclude-regex | exclude logs matching a regular expression. May be repeated. |
| --exclude-regex-file | path to a file containing regular expressions, one per line, to exclude. |
| --tag | filter for only logs with a given tag. May be repeated. |
| --exclude-tags | exclude logs with a given tag. May be repeated. |
| --severity | set the minimum severity. Accepted values (from lower to higher) are: trace, debug, info, warn (or warning), error, fatal. This field is case insensitive. |
| --kernel | outputs only kernel logs, unless combined with --component. |
| --since | show only logs after a certain time (exclusive) |
| --since-boot | show only logs after a certain time (as a boot timestamp: seconds from the target's boot time). |
| --until | show only logs until a certain time (exclusive) |
| --until-boot | show only logs until a certain time (as a boot timestamp: seconds since the target's boot time). |
| --hide-tags | hide the tag field from output (does not exclude any log messages) |
| --hide-file | hide the file and line number field from output (does not exclude any log messages) |
| --no-color | disable coloring logs according to severity. Note that you can permanently disable this with `ffx config set log_cmd.color false` |
| --case-sensitive | if enabled, text filtering options are case-sensitive this applies to --filter, --exclude, --tag, and --exclude-tags. |
| --show-metadata | shows process-id and thread-id in log output |
| --show-full-moniker | shows the full moniker in log output. By default this is false and only the last segment of the moniker is printed. |
| --prefer-url-component-name | if enabled, prefer using the component URL for the component name over the moniker. |
| --hide-moniker | hide the moniker field from output (does not exclude any log messages) |
| --clock | how to display log timestamps. Options are "utc", "local", or "boot" (i.e. nanos since target boot). Default is boot. |
| --symbolize | configure symbolization options. Valid options are: - pretty (default): pretty concise symbolization - off: disables all symbolization - classic: traditional, non-prettified symbolization |
| --pid | filters by pid |
| --tid | filters by tid |
| --force-set-severity | if enabled, selectors will be passed directly to Archivist without any filtering. If disabled and no matching components are found, the user will be prompted to either enable this or be given a list of selectors to choose from. This applies to both --set-severity and the set-severity subcommand. |
| --disable-reconnect | disable automatic reconnect |

## monitor

Start a local server to monitor status.


    Usage:  ffx monitor [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [intentional-disconnect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_monitor_intentional-disconnect) | Notify monitor of an intentional disconnect |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_monitor_start) | Start the monitor server |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_monitor_status) | Check the statuses |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_monitor_stop) | Stop the monitor server |

**Examples**

```
ffx monitor start
```

### intentional-disconnect

Notify monitor of an intentional disconnect


    Usage:  ffx monitor intentional-disconnect --nodename <nodename>

| **Options** |   |
|---|---|
| --help | display usage information |
| --nodename | specify the device nodename |

### start

Start the monitor server


    Usage:  ffx monitor start [--nodename <nodename>] [--port <port>] [--no-probe] [--no-mdns] [--no-usb] [--log-file <log-file>] [--aggregations-file <aggregations-file>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --nodename | specify the device nodename ffx going to monitor |
| --port | specify the port ffx monitor going to listen on |
| --no-probe | do not connect to targets (local discovery only) |
| --no-mdns | do not do mDNS discovery (local discovery only) |
| --no-usb | do not do USB discovery (local discovery only) |
| --log-file | file to store the monitor log file (relative to log.dir or absolute) |
| --aggregations-file | file to store the monitor log aggregations file (relative to log.dir or absolute) |

**Examples**

```
To start the monitor with a specific device:
  ffx monitor start --nodename fuchsia-1234-5678-90ab

To start the monitor on a specific port:
  ffx monitor start --port 8080
```

### status

Check the statuses


    Usage:  ffx monitor status

| **Options** |   |
|---|---|
| --help | display usage information |

### stop

Stop the monitor server


    Usage:  ffx monitor stop

| **Options** |   |
|---|---|
| --help | display usage information |

## net

View and manage target network configuration


    Usage:  ffx net [--realm <realm>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --realm | a realm to target when sending commands. Defaults to the core network realm. |

| **Subcommands** |   |
|---|---|
| [capture](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_capture) | Subcommands available for capture. Manage rolling packet captures |
| [dhcp](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcp) | commands for an interfaces dhcp client |
| [dhcpd](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd) | commands to control a dhcp server |
| [dns](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dns) | commands to control the dns resolver |
| [filter](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter) | commands for configuring packet filtering |
| [if](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if) | commands for network interfaces |
| [log](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_log) | commands for logging |
| [neigh](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh) | commands for neighbor tables |
| [route](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_route) | commands for routing tables |
| [rule](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_rule) | commands for policy-based-routing rules |

### capture

Subcommands available for capture. Manage rolling packet captures


    Usage:  ffx net capture [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start-rolling](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_capture_start-rolling) | Arguments for the `start-rolling` subcommand. Start a rolling packet capture |
| [stop-rolling](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_capture_stop-rolling) | Arguments for the `stop-rolling` subcommand. Stop and download a packet capture |

#### start-rolling

Arguments for the `start-rolling` subcommand. Start a rolling packet capture


    Usage:  ffx net capture start-rolling [--name <name>] [--snap-len <snap-len>] [--capture-size <capture-size>] interface [pcap_filter]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | name to assign to this rolling packet capture upon detaching (maximum 64 characters) If omitted, a default name will be used. |
| --snap-len | number of bytes from the start of each packet to save Defaults to 262144 (256 KiB) if 0 or absent. |
| --capture-size | buffer size in bytes for the rolling capture Must be between 262144 (256 KiB) and 16777216 (16 MiB). Defaults to 2097152 (2 MiB) if 0 or absent. |

#### stop-rolling

Arguments for the `stop-rolling` subcommand. Stop and download a packet capture


    Usage:  ffx net capture stop-rolling [--name <name>] [--output <output>] [--skip-download]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | name of the detached rolling packet capture to stop If omitted, the default name will be used. |
| --output | destination file path to save the pcapng file If omitted, defaults to `/tmp/pcap/&#123;&#123;name&#125;&#125;.pcapng`. Cannot be used with --skip-download. |
| --skip-download | stop the capture and discard the data without downloading Cannot be used with --output. |

### dhcp

commands for an interfaces dhcp client


    Usage:  ffx net dhcp [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcp_start) | starts a dhcp client on the interface |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcp_stop) | stops the dhcp client on the interface |

#### start

starts a dhcp client on the interface


    Usage:  ffx net dhcp start nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |

#### stop

stops the dhcp client on the interface


    Usage:  ffx net dhcp stop nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |

### dhcpd

commands to control a dhcp server


    Usage:  ffx net dhcpd [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [clear-leases](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_clear-leases) | A primary command to clear the leases maintained by dhcpd. |
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get) | A primary command to retrieve the value of a DHCP option or server parameter. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_list) | A primary command to list the values of all DHCP options or server parameters. |
| [reset](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_reset) | A primary command to reset the values of all DHCP options or server parameters. |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set) | A primary command to set the value of a DHCP option or server parameter. |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_start) | A primary command to start the DHCP server. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_stop) | A primary command to stop the DHCP server. |

#### clear-leases

A primary command to clear the leases maintained by dhcpd.


    Usage:  ffx net dhcpd clear-leases

| **Options** |   |
|---|---|
| --help | display usage information |

#### get

A primary command to retrieve the value of a DHCP option or server parameter.


    Usage:  ffx net dhcpd get [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [option](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option) | A secondary command indicating a DHCP option argument. |
| [parameter](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_parameter) | A secondary command indicating a server parameter argument. |

##### option

A secondary command indicating a DHCP option argument.


    Usage:  ffx net dhcpd get option [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [all-subnets-local](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_all-subnets-local) | Flag indicating if all subnets of the connected network have the same MTU. |
| [arp-cache-timeout](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_arp-cache-timeout) | Timeout for ARP cache entries. |
| [boot-file-size](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_boot-file-size) | Size of the default boot image for the client. |
| [bootfile-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_bootfile-name) | Bootfile name for the client. |
| [broadcast-address](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_broadcast-address) | Broadcast address of the client's subnet. |
| [cookie-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_cookie-server) | RFC 865 Cookie servers available to the client. |
| [default-finger-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_default-finger-server) | Default Finger servers available to the client. |
| [default-ip-ttl](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_default-ip-ttl) | Default time-to-live to use on outgoing IP datagrams. |
| [default-irc-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_default-irc-server) | Default IRC servers available to the client. |
| [default-www-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_default-www-server) | Default WWW servers available to the client. |
| [domain-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_domain-name) | Domain name of the client. |
| [domain-name-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_domain-name-server) | Domain Name System servers available to the client. |
| [ethernet-encapsulation](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_ethernet-encapsulation) | Flag specifying whether the client should use Ethernet v2 or IEEE 802.3 encapsulation. |
| [extensions-path](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_extensions-path) | Path name to a TFTP-retrievable file containing vendor-extension information. |
| [host-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_host-name) | Name of the client. |
| [impress-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_impress-server) | Imagen Impress servers available to the client. |
| [interface-mtu](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_interface-mtu) | MTU for the client's interface. |
| [ip-forwarding](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_ip-forwarding) | Flag enabling/disabling IP layer packet forwarding. |
| [log-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_log-server) | MIT-LCS UDP Log servers available to the client. |
| [lpr-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_lpr-server) | RFC 1179 Line Printer servers available to the client. |
| [mask-supplier](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_mask-supplier) | Flag indicating whether the client should respond to subnet mask discovery requests via ICMP. |
| [max-datagram-reassembly-size](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_max-datagram-reassembly-size) | Maximum sized datagram that the client should be able to reassemble. |
| [max-message-size](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_max-message-size) | Maximum length of a DHCP message that the participant is willing to accept. |
| [merit-dump-file](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_merit-dump-file) | Path name of a core dump file. |
| [mobile-ip-home-agent](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_mobile-ip-home-agent) | Mobile IP home agents available to the client. |
| [name-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_name-server) | IEN 116 Name servers available to the client. |
| [net-bios-over-tcpip-distribution-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_net-bios-over-tcpip-distribution-server) | NetBIOS datagram distribution servers available to the client. |
| [net-bios-over-tcpip-name-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_net-bios-over-tcpip-name-server) | NetBIOS name servers available to the client. |
| [net-bios-over-tcpip-node-type](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_net-bios-over-tcpip-node-type) | The NetBIOS node type which should be used by the client. |
| [net-bios-over-tcpip-scope](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_net-bios-over-tcpip-scope) | NetBIOS scope parameter for the client. |
| [network-information-servers](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_network-information-servers) | Network Information Service servers available to the client. |
| [network-information-service-domain](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_network-information-service-domain) | Name of the client's Network Information Service domain. |
| [network-information-service-plus-domain](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_network-information-service-plus-domain) | Network Information System+ domain name. |
| [network-information-service-plus-servers](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_network-information-service-plus-servers) | Network Information System+ servers available to the client. |
| [network-time-protocol-servers](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_network-time-protocol-servers) | Network Time Protocol servers available to the client. |
| [nntp-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_nntp-server) | NNTP servers available to the client. |
| [non-local-source-routing](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_non-local-source-routing) | Flag enabling/disabling forwarding of IP packets with non-local source routes. |
| [path-mtu-aging-timeout](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_path-mtu-aging-timeout) | Timeout to use when aging Path MTU values. |
| [path-mtu-plateau-table](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_path-mtu-plateau-table) | Table of MTU sizes for Path MTU Discovery. |
| [perform-mask-discovery](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_perform-mask-discovery) | Flag indicating whether the client should perform subnet mask discovery via ICMP. |
| [perform-router-discovery](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_perform-router-discovery) | Flag indicating whether the client should solicit routers using Router Discovery. |
| [policy-filter](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_policy-filter) | Policy filters for non-local source routing. |
| [pop3-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_pop3-server) | POP3 servers available to the client. |
| [rebinding-time-value](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_rebinding-time-value) | Time interval from address assignment at which the client transitions to a Rebinding state. |
| [renewal-time-value](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_renewal-time-value) | Time interval from address assignment at which the client transitions to a Renewing state. |
| [resource-location-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_resource-location-server) | RFC 887 Resource Location servers available to the client. |
| [root-path](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_root-path) | Path name to a TFTP-retrievable file containing vendor-extension information. |
| [router](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_router) | The routers within a client's subnet. |
| [router-solicitation-address](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_router-solicitation-address) | Destination address for Router Solicitation requests. |
| [smtp-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_smtp-server) | SMTP servers available to the client. |
| [static-route](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_static-route) | Static Routes which the client should put in its routing cache. |
| [stda-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_stda-server) | StreetTalk Directory Assistance servers available to the client. |
| [street-talk-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_street-talk-server) | StreetTalk servers available to the client. |
| [subnet-mask](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_subnet-mask) | The client's subnet mask. |
| [swap-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_swap-server) | Address of the client's swap server. |
| [tcp-default-ttl](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_tcp-default-ttl) | Default time-to-live for outgoing TCP segments. |
| [tcp-keepalive-garbage](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_tcp-keepalive-garbage) | Flag specifying whether the client should send TCP keepalive messages with an octet of garbage. |
| [tcp-keepalive-interval](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_tcp-keepalive-interval) | Interval the client should wait before sending a TCP keepalive message. |
| [tftp-server-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_tftp-server-name) | TFTP server available to the client. |
| [time-offset](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_time-offset) | The client's offset from UTC. |
| [time-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_time-server) | Time Protocol servers available to the client. |
| [trailer-encapsulation](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_trailer-encapsulation) | Flag specifying whether the client should negotiate the use of trailers in ARP. |
| [vendor-specific-information](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_vendor-specific-information) | Option for exchanging vendor-specific information between the DHCP client and DHCP server. |
| [x-window-system-display-manager](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_x-window-system-display-manager) | X window System Display Manager systems available to the client. |
| [x-window-system-font-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_x-window-system-font-server) | X Window System Font servers available to the client. |

###### all-subnets-local

Flag indicating if all subnets of the connected network have the same MTU.


    Usage:  ffx net dhcpd get option all-subnets-local [--local]

| **Options** |   |
|---|---|
| --help | display usage information |
| --local | a flag indicating if all subents of the IP network to which the client is connected have the same MTU. |

###### arp-cache-timeout

Timeout for ARP cache entries.


    Usage:  ffx net dhcpd get option arp-cache-timeout [--timeout <timeout>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --timeout | the timeout for ARP cache entries, in seconds. |

###### boot-file-size

Size of the default boot image for the client.


    Usage:  ffx net dhcpd get option boot-file-size [--size <size>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --size | the size of the client's default boot image in 512-octet blocks. |

###### bootfile-name

Bootfile name for the client.


    Usage:  ffx net dhcpd get option bootfile-name [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the bootfile name for the client. This option should be used when the `file` field has been overloaded to carry options. |

###### broadcast-address

Broadcast address of the client's subnet.


    Usage:  ffx net dhcpd get option broadcast-address [--addr <addr>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addr | the broadcast address of the client's subnet. Legal values are defined in RFC 1122. |

###### cookie-server

RFC 865 Cookie servers available to the client.


    Usage:  ffx net dhcpd get option cookie-server [--cookie-servers <cookie-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --cookie-servers | a list of RFC 865 Cookie servers available to the client, in order of preference. |

###### default-finger-server

Default Finger servers available to the client.


    Usage:  ffx net dhcpd get option default-finger-server [--finger-servers <finger-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --finger-servers | a list of default Finger server addresses available to the client, listed in order of preference. |

###### default-ip-ttl

Default time-to-live to use on outgoing IP datagrams.


    Usage:  ffx net dhcpd get option default-ip-ttl [--ttl <ttl>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ttl | the default time-to-live to use on outgoing IP datagrams. The value must be between 1 and 255. |

###### default-irc-server

Default IRC servers available to the client.


    Usage:  ffx net dhcpd get option default-irc-server [--irc-servers <irc-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --irc-servers | a list of Internet Relay Chat server addresses available to the client, listed in order of preference. |

###### default-www-server

Default WWW servers available to the client.


    Usage:  ffx net dhcpd get option default-www-server [--www-servers <www-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --www-servers | a list of default World Wide Web (WWW) server addresses available to the client, listed in order of preference. |

###### domain-name

Domain name of the client.


    Usage:  ffx net dhcpd get option domain-name [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the client's domain name for use in resolving hostnames in the DNS. |

###### domain-name-server

Domain Name System servers available to the client.


    Usage:  ffx net dhcpd get option domain-name-server [--domain-name-servers <domain-name-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --domain-name-servers | a list of DNS servers available to the client, in order of preference; |

###### ethernet-encapsulation

Flag specifying whether the client should use Ethernet v2 or IEEE 802.3 encapsulation.


    Usage:  ffx net dhcpd get option ethernet-encapsulation [--encapsulate]

| **Options** |   |
|---|---|
| --help | display usage information |
| --encapsulate | a flag specifying that the client should use Ethernet v2 encapsulation when false, and IEEE 802.3 encapsulation when true. |

###### extensions-path

Path name to a TFTP-retrievable file containing vendor-extension information.


    Usage:  ffx net dhcpd get option extensions-path [--path <path>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --path | the path name to a TFTP-retrievable file. This file contains data which can be interpreted as the BOOTP vendor-extension field. Unlike the BOOTP vendor-extension field, this file has an unconstrained length and any references to Tag 18 are ignored. |

###### host-name

Name of the client.


    Usage:  ffx net dhcpd get option host-name [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the name of client, which may or may not be qualified with the local domain name. |

###### impress-server

Imagen Impress servers available to the client.


    Usage:  ffx net dhcpd get option impress-server [--impress-servers <impress-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --impress-servers | a list of Imagen Impress servers available to the client, in order of preference. |

###### interface-mtu

MTU for the client's interface.


    Usage:  ffx net dhcpd get option interface-mtu [--mtu <mtu>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --mtu | the MTU for the client's interface. Minimum value of 68. |

###### ip-forwarding

Flag enabling/disabling IP layer packet forwarding.


    Usage:  ffx net dhcpd get option ip-forwarding [--enabled]

| **Options** |   |
|---|---|
| --help | display usage information |
| --enabled | a flag which will enabled IP layer packet forwarding when true. |

###### log-server

MIT-LCS UDP Log servers available to the client.


    Usage:  ffx net dhcpd get option log-server [--log-servers <log-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --log-servers | a list of MIT-LCS UDP Log servers available to the client, in order of preference. |

###### lpr-server

RFC 1179 Line Printer servers available to the client.


    Usage:  ffx net dhcpd get option lpr-server [--lpr-servers <lpr-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --lpr-servers | a list of RFC 1179 Line Printer servers available to the client, in order of preference. |

###### mask-supplier

Flag indicating whether the client should respond to subnet mask discovery requests via ICMP.


    Usage:  ffx net dhcpd get option mask-supplier [--supplier]

| **Options** |   |
|---|---|
| --help | display usage information |
| --supplier | a flag indicating whether the client should respond to subnet mask discovery requests via ICMP. |

###### max-datagram-reassembly-size

Maximum sized datagram that the client should be able to reassemble.


    Usage:  ffx net dhcpd get option max-datagram-reassembly-size [--size <size>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --size | the maximum sized datagram that the client should be able to reassemble, in octets. The minimum legal value is 576. |

###### max-message-size

Maximum length of a DHCP message that the participant is willing to accept.


    Usage:  ffx net dhcpd get option max-message-size [--length <length>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --length | the maximum length in octets of a DHCP message that the participant is willing to accept. The minimum value is 576. |

###### merit-dump-file

Path name of a core dump file.


    Usage:  ffx net dhcpd get option merit-dump-file [--path <path>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --path | the path name to the client's core dump in the event the client crashes. |

###### mobile-ip-home-agent

Mobile IP home agents available to the client.


    Usage:  ffx net dhcpd get option mobile-ip-home-agent [--home-agents <home-agents...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --home-agents | a list of mobile IP home agent addresses available to the client, listed in order of preference. |

###### name-server

IEN 116 Name servers available to the client.


    Usage:  ffx net dhcpd get option name-server [--name-servers <name-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name-servers | a list of IEN 116 Name servers available to the client, in order of preference. |

###### net-bios-over-tcpip-distribution-server

NetBIOS datagram distribution servers available to the client.


    Usage:  ffx net dhcpd get option net-bios-over-tcpip-distribution-server [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of NetBIOS datagram distribution servers available to the client, listed in order of preference. |

###### net-bios-over-tcpip-name-server

NetBIOS name servers available to the client.


    Usage:  ffx net dhcpd get option net-bios-over-tcpip-name-server [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of NetBIOS name server addresses available to the client, listed in order of preference. |

###### net-bios-over-tcpip-node-type

The NetBIOS node type which should be used by the client.


    Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [b-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_net-bios-over-tcpip-node-type_b-node) | A B node type. |
| [h-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_net-bios-over-tcpip-node-type_h-node) | A H node type. |
| [m-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_net-bios-over-tcpip-node-type_m-node) | A M node type. |
| [p-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_option_net-bios-over-tcpip-node-type_p-node) | A P node type. |

###### # b-node

A B node type.


    Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type b-node

| **Options** |   |
|---|---|
| --help | display usage information |

###### # h-node

A H node type.


    Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type h-node

| **Options** |   |
|---|---|
| --help | display usage information |

###### # m-node

A M node type.


    Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type m-node

| **Options** |   |
|---|---|
| --help | display usage information |

###### # p-node

A P node type.


    Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type p-node

| **Options** |   |
|---|---|
| --help | display usage information |

###### net-bios-over-tcpip-scope

NetBIOS scope parameter for the client.


    Usage:  ffx net dhcpd get option net-bios-over-tcpip-scope [--scope <scope>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --scope | the NetBIOS over TCP/IP scope parameter, as defined in RFC 1001, for the client. |

###### network-information-servers

Network Information Service servers available to the client.


    Usage:  ffx net dhcpd get option network-information-servers [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of Network Information Service server addresses available to the client, listed in order of preference. |

###### network-information-service-domain

Name of the client's Network Information Service domain.


    Usage:  ffx net dhcpd get option network-information-service-domain [--domain-name <domain-name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --domain-name | the name of the client's Network Information Service domain. |

###### network-information-service-plus-domain

Network Information System+ domain name.


    Usage:  ffx net dhcpd get option network-information-service-plus-domain [--domain-name <domain-name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --domain-name | the name of the client's Network Information System+ domain. |

###### network-information-service-plus-servers

Network Information System+ servers available to the client.


    Usage:  ffx net dhcpd get option network-information-service-plus-servers [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of Network Information System+ server addresses available to the client, listed in order of preference. |

###### network-time-protocol-servers

Network Time Protocol servers available to the client.


    Usage:  ffx net dhcpd get option network-time-protocol-servers [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of Network Time Protocol (NTP) server addresses available to the client, listed in order of preference. |

###### nntp-server

NNTP servers available to the client.


    Usage:  ffx net dhcpd get option nntp-server [--nntp-servers <nntp-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --nntp-servers | a list Network News Transport Protocol (NNTP) server addresses available to the client, listed in order of preference. |

###### non-local-source-routing

Flag enabling/disabling forwarding of IP packets with non-local source routes.


    Usage:  ffx net dhcpd get option non-local-source-routing [--enabled]

| **Options** |   |
|---|---|
| --help | display usage information |
| --enabled | a flag which will enable forwarding of IP packets with non-local source routes. |

###### path-mtu-aging-timeout

Timeout to use when aging Path MTU values.


    Usage:  ffx net dhcpd get option path-mtu-aging-timeout [--timeout <timeout>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --timeout | the timeout, in seconds, to be used when again Path MTU values by the mechanism in RFC 1191. |

###### path-mtu-plateau-table

Table of MTU sizes for Path MTU Discovery.


    Usage:  ffx net dhcpd get option path-mtu-plateau-table [--mtu-sizes <mtu-sizes...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --mtu-sizes | a list of MTU sizes, ordered from smallest to largest. The smallest value cannot be smaller than 68. |

###### perform-mask-discovery

Flag indicating whether the client should perform subnet mask discovery via ICMP.


    Usage:  ffx net dhcpd get option perform-mask-discovery [--do-discovery]

| **Options** |   |
|---|---|
| --help | display usage information |
| --do-discovery | a flag indicating whether the client should perform subnet mask discovery via ICMP. |

###### perform-router-discovery

Flag indicating whether the client should solicit routers using Router Discovery.


    Usage:  ffx net dhcpd get option perform-router-discovery [--do-discovery]

| **Options** |   |
|---|---|
| --help | display usage information |
| --do-discovery | a flag indicating whether the client should solicit routers using Router Discovery as defined in RFC 1256. |

###### policy-filter

Policy filters for non-local source routing.


    Usage:  ffx net dhcpd get option policy-filter [--addresses <addresses...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addresses | a list of IP Address and Subnet Mask pairs. If an incoming source-routed packet has a next-hop that does not match one of these pairs, then the packet will be dropped. |

###### pop3-server

POP3 servers available to the client.


    Usage:  ffx net dhcpd get option pop3-server [--pop3-servers <pop3-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --pop3-servers | a list of Post Office Protocol (POP3) server addresses available to the client, listed in order of preference. |

###### rebinding-time-value

Time interval from address assignment at which the client transitions to a Rebinding state.


    Usage:  ffx net dhcpd get option rebinding-time-value [--interval <interval>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --interval | the time interval, in seconds, after address assignment at which the client will transition to the Rebinding state. |

###### renewal-time-value

Time interval from address assignment at which the client transitions to a Renewing state.


    Usage:  ffx net dhcpd get option renewal-time-value [--interval <interval>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --interval | the time interval, in seconds, after address assignment at which the client will transition to the Renewing state. |

###### resource-location-server

RFC 887 Resource Location servers available to the client.


    Usage:  ffx net dhcpd get option resource-location-server [--resource-location-servers <resource-location-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --resource-location-servers | a list of RFC 887 Resource Location servers available to the client, in order of preference. |

###### root-path

Path name to a TFTP-retrievable file containing vendor-extension information.


    Usage:  ffx net dhcpd get option root-path [--path <path>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --path | the path name to a TFTP-retrievable file. This file contains data which can be interpreted as the BOOTP vendor-extension field. Unlike the BOOTP vendor-extension field, this file has an unconstrained length and any references to Tag 18 are ignored. |

###### router

The routers within a client's subnet.


    Usage:  ffx net dhcpd get option router [--routers <routers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --routers | a list of the routers in a client's subnet, listed in order of preference. |

###### router-solicitation-address

Destination address for Router Solicitation requests.


    Usage:  ffx net dhcpd get option router-solicitation-address [--addr <addr>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addr | the address to which the client should transmit Router Solicitation requests. |

###### smtp-server

SMTP servers available to the client.


    Usage:  ffx net dhcpd get option smtp-server [--smtp-servers <smtp-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --smtp-servers | a list of Simple Mail Transport Protocol (SMTP) server address available to the client, listed in order of preference. |

###### static-route

Static Routes which the client should put in its routing cache.


    Usage:  ffx net dhcpd get option static-route [--routes <routes...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --routes | a list of Destination address/Next-hop address pairs defining static routes for the client's routing table. The routes should be listed in descending order of priority. It is illegal to use 0.0.0.0 as the destination in a static route. |

###### stda-server

StreetTalk Directory Assistance servers available to the client.


    Usage:  ffx net dhcpd get option stda-server [--stda-servers <stda-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --stda-servers | a list of StreetTalk Directory Assistance server addresses available to the client, listed in order of preference. |

###### street-talk-server

StreetTalk servers available to the client.


    Usage:  ffx net dhcpd get option street-talk-server [--streettalk-servers <streettalk-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --streettalk-servers | a list of StreetTalk server addresses available to the client, listed in order of preference. |

###### subnet-mask

The client's subnet mask.


    Usage:  ffx net dhcpd get option subnet-mask [--mask <mask>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --mask | a 32-bit IPv4 subnet mask. |

###### swap-server

Address of the client's swap server.


    Usage:  ffx net dhcpd get option swap-server [--address <address>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --address | the address of the client's swap server. |

###### tcp-default-ttl

Default time-to-live for outgoing TCP segments.


    Usage:  ffx net dhcpd get option tcp-default-ttl [--ttl <ttl>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ttl | the default time-to-live that the client should use for outgoing TCP segments. The minimum value is 1. |

###### tcp-keepalive-garbage

Flag specifying whether the client should send TCP keepalive messages with an octet of garbage.


    Usage:  ffx net dhcpd get option tcp-keepalive-garbage [--send-garbage]

| **Options** |   |
|---|---|
| --help | display usage information |
| --send-garbage | a flag specifying whether the client should send TCP keepalive messages with an octet of garbage for compatibility with older implementations. |

###### tcp-keepalive-interval

Interval the client should wait before sending a TCP keepalive message.


    Usage:  ffx net dhcpd get option tcp-keepalive-interval [--interval <interval>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --interval | the interval, in seconds, the client should wait before sending a TCP keepalive message. A value of 0 indicates that the client should not send keepalive messages unless specifically requested by an application. |

###### tftp-server-name

TFTP server available to the client.


    Usage:  ffx net dhcpd get option tftp-server-name [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the TFTP server name available to the client. This option should be used when the `sname` field has been overloaded to carry options. |

###### time-offset

The client's offset from UTC.


    Usage:  ffx net dhcpd get option time-offset [--offset <offset>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --offset | the client's offset from UTC in seconds. A positive offset is east of the zero meridian, and a negative offset is west of the zero meridian. |

###### time-server

Time Protocol servers available to the client.


    Usage:  ffx net dhcpd get option time-server [--time-servers <time-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --time-servers | a list of time servers available to the client, in order of preference. |

###### trailer-encapsulation

Flag specifying whether the client should negotiate the use of trailers in ARP.


    Usage:  ffx net dhcpd get option trailer-encapsulation [--trailers]

| **Options** |   |
|---|---|
| --help | display usage information |
| --trailers | a flag specifying whether the client negotiate the use of trailers when using ARP, per RFC 893. |

###### vendor-specific-information

Option for exchanging vendor-specific information between the DHCP client and DHCP server.


    Usage:  ffx net dhcpd get option vendor-specific-information [--data <data...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --data | an opaque object of octets for exchanging vendor-specific information. |

###### x-window-system-display-manager

X window System Display Manager systems available to the client.


    Usage:  ffx net dhcpd get option x-window-system-display-manager [--display-servers <display-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --display-servers | a list of X Window System Display Manager system addresses available to the client, listed in order of preference. |

###### x-window-system-font-server

X Window System Font servers available to the client.


    Usage:  ffx net dhcpd get option x-window-system-font-server [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of X Window System Font server addresses available to the client, listed in order of preference. |

##### parameter

A secondary command indicating a server parameter argument.


    Usage:  ffx net dhcpd get parameter [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [address-pool](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_parameter_address-pool) | The pool of addresses which the DHCP server manages. |
| [arp-probe](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_parameter_arp-probe) | Enables server behavior where the server ARPs an IP address prior to issuing it in a lease. |
| [bound-device-names](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_parameter_bound-device-names) | The names of the network devices on which the server will listen. |
| [ip-addrs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_parameter_ip-addrs) | The IPv4 addresses to which the server is bound. |
| [lease-length](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_parameter_lease-length) | The duration of leases offered by the server. |
| [permitted-macs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_parameter_permitted-macs) | The client MAC addresses which the server will issue leases to. |
| [statically-assigned-addrs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_get_parameter_statically-assigned-addrs) | Addresses in the AddressPool which will only be leased to specified clients. Assigned addresses will be paired with hosts in order, e.g. hosts (A, B, C) and addresses (1, 2, 3) pair as ((A, 1), (B, 2), (C, 3)). |

###### address-pool

The pool of addresses which the DHCP server manages.


    Usage:  ffx net dhcpd get parameter address-pool [--prefix-length <prefix-length>] [--range-start <range-start>] [--range-stop <range-stop>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --prefix-length | the prefix length of the network's subnet mask |
| --range-start | the starting address, inclusive, of the range of addresses which the DHCP server will lease to clients |
| --range-stop | the ending address, inclusive, of the range of addresses which the server will to clients |

###### arp-probe

Enables server behavior where the server ARPs an IP address prior to issuing it in a lease.


    Usage:  ffx net dhcpd get parameter arp-probe [--enabled]

| **Options** |   |
|---|---|
| --help | display usage information |
| --enabled | enables server behavior where the server ARPs an IP address prior to issuing it in a lease. If the server receives a response, the server will mark the address as in-use and try again with a different address. By default, this behavior is disabled. |

###### bound-device-names

The names of the network devices on which the server will listen.


    Usage:  ffx net dhcpd get parameter bound-device-names [names...]

| **Options** |   |
|---|---|
| --help | display usage information |

###### ip-addrs

The IPv4 addresses to which the server is bound.


    Usage:  ffx net dhcpd get parameter ip-addrs [--addrs <addrs...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addrs | a list of IPv4 Addresses to which the server is bound. |

###### lease-length

The duration of leases offered by the server.


    Usage:  ffx net dhcpd get parameter lease-length [--default <default>] [--max <max>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --default | the default lease length, in seconds, to be issued to clients. |
| --max | the maximum lease length value, in seconds, which the server will issue to clients who have requested a specific lease length. With the default value of 0, the max lease length is equivalent to the default lease length. |

###### permitted-macs

The client MAC addresses which the server will issue leases to.


    Usage:  ffx net dhcpd get parameter permitted-macs [--macs <macs...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --macs | the client MAC addresses which the server will issue leases to. By default, the server will not have a permitted MAC list, in which case it will attempt to issue a lease to every client which requests one. If permitted_macs has a non-zero length then the server will only respond to lease requests from clients with a MAC in the list. |

###### statically-assigned-addrs

Addresses in the AddressPool which will only be leased to specified clients. Assigned addresses will be paired with hosts in order, e.g. hosts (A, B, C) and addresses (1, 2, 3) pair as ((A, 1), (B, 2), (C, 3)).


    Usage:  ffx net dhcpd get parameter statically-assigned-addrs [--hosts <hosts...>] [--assigned-addrs <assigned-addrs...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --hosts | hosts which will be leased the addresses reserved by `assigned_addrs`. |
| --assigned-addrs | addresses in the AddressPool which will not be leased to clients. Typically, a network administrator will statically assign these addresses to always-on network devices which should always have the same IP address, such as network printers. |

#### list

A primary command to list the values of all DHCP options or server parameters.


    Usage:  ffx net dhcpd list [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [option](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_list_option) | Perform the command on DHCP options. |
| [parameter](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_list_parameter) | Perform the command on server parameters. |

##### option

Perform the command on DHCP options.


    Usage:  ffx net dhcpd list option

| **Options** |   |
|---|---|
| --help | display usage information |

##### parameter

Perform the command on server parameters.


    Usage:  ffx net dhcpd list parameter

| **Options** |   |
|---|---|
| --help | display usage information |

#### reset

A primary command to reset the values of all DHCP options or server parameters.


    Usage:  ffx net dhcpd reset [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [option](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_reset_option) | Perform the command on DHCP options. |
| [parameter](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_reset_parameter) | Perform the command on server parameters. |

##### option

Perform the command on DHCP options.


    Usage:  ffx net dhcpd reset option

| **Options** |   |
|---|---|
| --help | display usage information |

##### parameter

Perform the command on server parameters.


    Usage:  ffx net dhcpd reset parameter

| **Options** |   |
|---|---|
| --help | display usage information |

#### set

A primary command to set the value of a DHCP option or server parameter.


    Usage:  ffx net dhcpd set [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [option](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option) | A secondary command indicating a DHCP option argument. |
| [parameter](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_parameter) | A secondary command indicating a server parameter argument. |

##### option

A secondary command indicating a DHCP option argument.


    Usage:  ffx net dhcpd set option [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [all-subnets-local](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_all-subnets-local) | Flag indicating if all subnets of the connected network have the same MTU. |
| [arp-cache-timeout](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_arp-cache-timeout) | Timeout for ARP cache entries. |
| [boot-file-size](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_boot-file-size) | Size of the default boot image for the client. |
| [bootfile-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_bootfile-name) | Bootfile name for the client. |
| [broadcast-address](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_broadcast-address) | Broadcast address of the client's subnet. |
| [cookie-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_cookie-server) | RFC 865 Cookie servers available to the client. |
| [default-finger-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_default-finger-server) | Default Finger servers available to the client. |
| [default-ip-ttl](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_default-ip-ttl) | Default time-to-live to use on outgoing IP datagrams. |
| [default-irc-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_default-irc-server) | Default IRC servers available to the client. |
| [default-www-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_default-www-server) | Default WWW servers available to the client. |
| [domain-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_domain-name) | Domain name of the client. |
| [domain-name-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_domain-name-server) | Domain Name System servers available to the client. |
| [ethernet-encapsulation](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_ethernet-encapsulation) | Flag specifying whether the client should use Ethernet v2 or IEEE 802.3 encapsulation. |
| [extensions-path](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_extensions-path) | Path name to a TFTP-retrievable file containing vendor-extension information. |
| [host-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_host-name) | Name of the client. |
| [impress-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_impress-server) | Imagen Impress servers available to the client. |
| [interface-mtu](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_interface-mtu) | MTU for the client's interface. |
| [ip-forwarding](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_ip-forwarding) | Flag enabling/disabling IP layer packet forwarding. |
| [log-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_log-server) | MIT-LCS UDP Log servers available to the client. |
| [lpr-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_lpr-server) | RFC 1179 Line Printer servers available to the client. |
| [mask-supplier](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_mask-supplier) | Flag indicating whether the client should respond to subnet mask discovery requests via ICMP. |
| [max-datagram-reassembly-size](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_max-datagram-reassembly-size) | Maximum sized datagram that the client should be able to reassemble. |
| [max-message-size](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_max-message-size) | Maximum length of a DHCP message that the participant is willing to accept. |
| [merit-dump-file](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_merit-dump-file) | Path name of a core dump file. |
| [mobile-ip-home-agent](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_mobile-ip-home-agent) | Mobile IP home agents available to the client. |
| [name-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_name-server) | IEN 116 Name servers available to the client. |
| [net-bios-over-tcpip-distribution-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_net-bios-over-tcpip-distribution-server) | NetBIOS datagram distribution servers available to the client. |
| [net-bios-over-tcpip-name-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_net-bios-over-tcpip-name-server) | NetBIOS name servers available to the client. |
| [net-bios-over-tcpip-node-type](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_net-bios-over-tcpip-node-type) | The NetBIOS node type which should be used by the client. |
| [net-bios-over-tcpip-scope](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_net-bios-over-tcpip-scope) | NetBIOS scope parameter for the client. |
| [network-information-servers](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_network-information-servers) | Network Information Service servers available to the client. |
| [network-information-service-domain](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_network-information-service-domain) | Name of the client's Network Information Service domain. |
| [network-information-service-plus-domain](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_network-information-service-plus-domain) | Network Information System+ domain name. |
| [network-information-service-plus-servers](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_network-information-service-plus-servers) | Network Information System+ servers available to the client. |
| [network-time-protocol-servers](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_network-time-protocol-servers) | Network Time Protocol servers available to the client. |
| [nntp-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_nntp-server) | NNTP servers available to the client. |
| [non-local-source-routing](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_non-local-source-routing) | Flag enabling/disabling forwarding of IP packets with non-local source routes. |
| [path-mtu-aging-timeout](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_path-mtu-aging-timeout) | Timeout to use when aging Path MTU values. |
| [path-mtu-plateau-table](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_path-mtu-plateau-table) | Table of MTU sizes for Path MTU Discovery. |
| [perform-mask-discovery](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_perform-mask-discovery) | Flag indicating whether the client should perform subnet mask discovery via ICMP. |
| [perform-router-discovery](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_perform-router-discovery) | Flag indicating whether the client should solicit routers using Router Discovery. |
| [policy-filter](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_policy-filter) | Policy filters for non-local source routing. |
| [pop3-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_pop3-server) | POP3 servers available to the client. |
| [rebinding-time-value](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_rebinding-time-value) | Time interval from address assignment at which the client transitions to a Rebinding state. |
| [renewal-time-value](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_renewal-time-value) | Time interval from address assignment at which the client transitions to a Renewing state. |
| [resource-location-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_resource-location-server) | RFC 887 Resource Location servers available to the client. |
| [root-path](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_root-path) | Path name to a TFTP-retrievable file containing vendor-extension information. |
| [router](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_router) | The routers within a client's subnet. |
| [router-solicitation-address](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_router-solicitation-address) | Destination address for Router Solicitation requests. |
| [smtp-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_smtp-server) | SMTP servers available to the client. |
| [static-route](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_static-route) | Static Routes which the client should put in its routing cache. |
| [stda-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_stda-server) | StreetTalk Directory Assistance servers available to the client. |
| [street-talk-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_street-talk-server) | StreetTalk servers available to the client. |
| [subnet-mask](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_subnet-mask) | The client's subnet mask. |
| [swap-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_swap-server) | Address of the client's swap server. |
| [tcp-default-ttl](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_tcp-default-ttl) | Default time-to-live for outgoing TCP segments. |
| [tcp-keepalive-garbage](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_tcp-keepalive-garbage) | Flag specifying whether the client should send TCP keepalive messages with an octet of garbage. |
| [tcp-keepalive-interval](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_tcp-keepalive-interval) | Interval the client should wait before sending a TCP keepalive message. |
| [tftp-server-name](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_tftp-server-name) | TFTP server available to the client. |
| [time-offset](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_time-offset) | The client's offset from UTC. |
| [time-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_time-server) | Time Protocol servers available to the client. |
| [trailer-encapsulation](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_trailer-encapsulation) | Flag specifying whether the client should negotiate the use of trailers in ARP. |
| [vendor-specific-information](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_vendor-specific-information) | Option for exchanging vendor-specific information between the DHCP client and DHCP server. |
| [x-window-system-display-manager](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_x-window-system-display-manager) | X window System Display Manager systems available to the client. |
| [x-window-system-font-server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_x-window-system-font-server) | X Window System Font servers available to the client. |

###### all-subnets-local

Flag indicating if all subnets of the connected network have the same MTU.


    Usage:  ffx net dhcpd set option all-subnets-local [--local]

| **Options** |   |
|---|---|
| --help | display usage information |
| --local | a flag indicating if all subents of the IP network to which the client is connected have the same MTU. |

###### arp-cache-timeout

Timeout for ARP cache entries.


    Usage:  ffx net dhcpd set option arp-cache-timeout [--timeout <timeout>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --timeout | the timeout for ARP cache entries, in seconds. |

###### boot-file-size

Size of the default boot image for the client.


    Usage:  ffx net dhcpd set option boot-file-size [--size <size>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --size | the size of the client's default boot image in 512-octet blocks. |

###### bootfile-name

Bootfile name for the client.


    Usage:  ffx net dhcpd set option bootfile-name [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the bootfile name for the client. This option should be used when the `file` field has been overloaded to carry options. |

###### broadcast-address

Broadcast address of the client's subnet.


    Usage:  ffx net dhcpd set option broadcast-address [--addr <addr>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addr | the broadcast address of the client's subnet. Legal values are defined in RFC 1122. |

###### cookie-server

RFC 865 Cookie servers available to the client.


    Usage:  ffx net dhcpd set option cookie-server [--cookie-servers <cookie-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --cookie-servers | a list of RFC 865 Cookie servers available to the client, in order of preference. |

###### default-finger-server

Default Finger servers available to the client.


    Usage:  ffx net dhcpd set option default-finger-server [--finger-servers <finger-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --finger-servers | a list of default Finger server addresses available to the client, listed in order of preference. |

###### default-ip-ttl

Default time-to-live to use on outgoing IP datagrams.


    Usage:  ffx net dhcpd set option default-ip-ttl [--ttl <ttl>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ttl | the default time-to-live to use on outgoing IP datagrams. The value must be between 1 and 255. |

###### default-irc-server

Default IRC servers available to the client.


    Usage:  ffx net dhcpd set option default-irc-server [--irc-servers <irc-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --irc-servers | a list of Internet Relay Chat server addresses available to the client, listed in order of preference. |

###### default-www-server

Default WWW servers available to the client.


    Usage:  ffx net dhcpd set option default-www-server [--www-servers <www-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --www-servers | a list of default World Wide Web (WWW) server addresses available to the client, listed in order of preference. |

###### domain-name

Domain name of the client.


    Usage:  ffx net dhcpd set option domain-name [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the client's domain name for use in resolving hostnames in the DNS. |

###### domain-name-server

Domain Name System servers available to the client.


    Usage:  ffx net dhcpd set option domain-name-server [--domain-name-servers <domain-name-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --domain-name-servers | a list of DNS servers available to the client, in order of preference; |

###### ethernet-encapsulation

Flag specifying whether the client should use Ethernet v2 or IEEE 802.3 encapsulation.


    Usage:  ffx net dhcpd set option ethernet-encapsulation [--encapsulate]

| **Options** |   |
|---|---|
| --help | display usage information |
| --encapsulate | a flag specifying that the client should use Ethernet v2 encapsulation when false, and IEEE 802.3 encapsulation when true. |

###### extensions-path

Path name to a TFTP-retrievable file containing vendor-extension information.


    Usage:  ffx net dhcpd set option extensions-path [--path <path>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --path | the path name to a TFTP-retrievable file. This file contains data which can be interpreted as the BOOTP vendor-extension field. Unlike the BOOTP vendor-extension field, this file has an unconstrained length and any references to Tag 18 are ignored. |

###### host-name

Name of the client.


    Usage:  ffx net dhcpd set option host-name [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the name of client, which may or may not be qualified with the local domain name. |

###### impress-server

Imagen Impress servers available to the client.


    Usage:  ffx net dhcpd set option impress-server [--impress-servers <impress-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --impress-servers | a list of Imagen Impress servers available to the client, in order of preference. |

###### interface-mtu

MTU for the client's interface.


    Usage:  ffx net dhcpd set option interface-mtu [--mtu <mtu>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --mtu | the MTU for the client's interface. Minimum value of 68. |

###### ip-forwarding

Flag enabling/disabling IP layer packet forwarding.


    Usage:  ffx net dhcpd set option ip-forwarding [--enabled]

| **Options** |   |
|---|---|
| --help | display usage information |
| --enabled | a flag which will enabled IP layer packet forwarding when true. |

###### log-server

MIT-LCS UDP Log servers available to the client.


    Usage:  ffx net dhcpd set option log-server [--log-servers <log-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --log-servers | a list of MIT-LCS UDP Log servers available to the client, in order of preference. |

###### lpr-server

RFC 1179 Line Printer servers available to the client.


    Usage:  ffx net dhcpd set option lpr-server [--lpr-servers <lpr-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --lpr-servers | a list of RFC 1179 Line Printer servers available to the client, in order of preference. |

###### mask-supplier

Flag indicating whether the client should respond to subnet mask discovery requests via ICMP.


    Usage:  ffx net dhcpd set option mask-supplier [--supplier]

| **Options** |   |
|---|---|
| --help | display usage information |
| --supplier | a flag indicating whether the client should respond to subnet mask discovery requests via ICMP. |

###### max-datagram-reassembly-size

Maximum sized datagram that the client should be able to reassemble.


    Usage:  ffx net dhcpd set option max-datagram-reassembly-size [--size <size>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --size | the maximum sized datagram that the client should be able to reassemble, in octets. The minimum legal value is 576. |

###### max-message-size

Maximum length of a DHCP message that the participant is willing to accept.


    Usage:  ffx net dhcpd set option max-message-size [--length <length>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --length | the maximum length in octets of a DHCP message that the participant is willing to accept. The minimum value is 576. |

###### merit-dump-file

Path name of a core dump file.


    Usage:  ffx net dhcpd set option merit-dump-file [--path <path>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --path | the path name to the client's core dump in the event the client crashes. |

###### mobile-ip-home-agent

Mobile IP home agents available to the client.


    Usage:  ffx net dhcpd set option mobile-ip-home-agent [--home-agents <home-agents...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --home-agents | a list of mobile IP home agent addresses available to the client, listed in order of preference. |

###### name-server

IEN 116 Name servers available to the client.


    Usage:  ffx net dhcpd set option name-server [--name-servers <name-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name-servers | a list of IEN 116 Name servers available to the client, in order of preference. |

###### net-bios-over-tcpip-distribution-server

NetBIOS datagram distribution servers available to the client.


    Usage:  ffx net dhcpd set option net-bios-over-tcpip-distribution-server [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of NetBIOS datagram distribution servers available to the client, listed in order of preference. |

###### net-bios-over-tcpip-name-server

NetBIOS name servers available to the client.


    Usage:  ffx net dhcpd set option net-bios-over-tcpip-name-server [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of NetBIOS name server addresses available to the client, listed in order of preference. |

###### net-bios-over-tcpip-node-type

The NetBIOS node type which should be used by the client.


    Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [b-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_net-bios-over-tcpip-node-type_b-node) | A B node type. |
| [h-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_net-bios-over-tcpip-node-type_h-node) | A H node type. |
| [m-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_net-bios-over-tcpip-node-type_m-node) | A M node type. |
| [p-node](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_option_net-bios-over-tcpip-node-type_p-node) | A P node type. |

###### # b-node

A B node type.


    Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type b-node

| **Options** |   |
|---|---|
| --help | display usage information |

###### # h-node

A H node type.


    Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type h-node

| **Options** |   |
|---|---|
| --help | display usage information |

###### # m-node

A M node type.


    Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type m-node

| **Options** |   |
|---|---|
| --help | display usage information |

###### # p-node

A P node type.


    Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type p-node

| **Options** |   |
|---|---|
| --help | display usage information |

###### net-bios-over-tcpip-scope

NetBIOS scope parameter for the client.


    Usage:  ffx net dhcpd set option net-bios-over-tcpip-scope [--scope <scope>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --scope | the NetBIOS over TCP/IP scope parameter, as defined in RFC 1001, for the client. |

###### network-information-servers

Network Information Service servers available to the client.


    Usage:  ffx net dhcpd set option network-information-servers [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of Network Information Service server addresses available to the client, listed in order of preference. |

###### network-information-service-domain

Name of the client's Network Information Service domain.


    Usage:  ffx net dhcpd set option network-information-service-domain [--domain-name <domain-name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --domain-name | the name of the client's Network Information Service domain. |

###### network-information-service-plus-domain

Network Information System+ domain name.


    Usage:  ffx net dhcpd set option network-information-service-plus-domain [--domain-name <domain-name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --domain-name | the name of the client's Network Information System+ domain. |

###### network-information-service-plus-servers

Network Information System+ servers available to the client.


    Usage:  ffx net dhcpd set option network-information-service-plus-servers [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of Network Information System+ server addresses available to the client, listed in order of preference. |

###### network-time-protocol-servers

Network Time Protocol servers available to the client.


    Usage:  ffx net dhcpd set option network-time-protocol-servers [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of Network Time Protocol (NTP) server addresses available to the client, listed in order of preference. |

###### nntp-server

NNTP servers available to the client.


    Usage:  ffx net dhcpd set option nntp-server [--nntp-servers <nntp-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --nntp-servers | a list Network News Transport Protocol (NNTP) server addresses available to the client, listed in order of preference. |

###### non-local-source-routing

Flag enabling/disabling forwarding of IP packets with non-local source routes.


    Usage:  ffx net dhcpd set option non-local-source-routing [--enabled]

| **Options** |   |
|---|---|
| --help | display usage information |
| --enabled | a flag which will enable forwarding of IP packets with non-local source routes. |

###### path-mtu-aging-timeout

Timeout to use when aging Path MTU values.


    Usage:  ffx net dhcpd set option path-mtu-aging-timeout [--timeout <timeout>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --timeout | the timeout, in seconds, to be used when again Path MTU values by the mechanism in RFC 1191. |

###### path-mtu-plateau-table

Table of MTU sizes for Path MTU Discovery.


    Usage:  ffx net dhcpd set option path-mtu-plateau-table [--mtu-sizes <mtu-sizes...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --mtu-sizes | a list of MTU sizes, ordered from smallest to largest. The smallest value cannot be smaller than 68. |

###### perform-mask-discovery

Flag indicating whether the client should perform subnet mask discovery via ICMP.


    Usage:  ffx net dhcpd set option perform-mask-discovery [--do-discovery]

| **Options** |   |
|---|---|
| --help | display usage information |
| --do-discovery | a flag indicating whether the client should perform subnet mask discovery via ICMP. |

###### perform-router-discovery

Flag indicating whether the client should solicit routers using Router Discovery.


    Usage:  ffx net dhcpd set option perform-router-discovery [--do-discovery]

| **Options** |   |
|---|---|
| --help | display usage information |
| --do-discovery | a flag indicating whether the client should solicit routers using Router Discovery as defined in RFC 1256. |

###### policy-filter

Policy filters for non-local source routing.


    Usage:  ffx net dhcpd set option policy-filter [--addresses <addresses...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addresses | a list of IP Address and Subnet Mask pairs. If an incoming source-routed packet has a next-hop that does not match one of these pairs, then the packet will be dropped. |

###### pop3-server

POP3 servers available to the client.


    Usage:  ffx net dhcpd set option pop3-server [--pop3-servers <pop3-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --pop3-servers | a list of Post Office Protocol (POP3) server addresses available to the client, listed in order of preference. |

###### rebinding-time-value

Time interval from address assignment at which the client transitions to a Rebinding state.


    Usage:  ffx net dhcpd set option rebinding-time-value [--interval <interval>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --interval | the time interval, in seconds, after address assignment at which the client will transition to the Rebinding state. |

###### renewal-time-value

Time interval from address assignment at which the client transitions to a Renewing state.


    Usage:  ffx net dhcpd set option renewal-time-value [--interval <interval>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --interval | the time interval, in seconds, after address assignment at which the client will transition to the Renewing state. |

###### resource-location-server

RFC 887 Resource Location servers available to the client.


    Usage:  ffx net dhcpd set option resource-location-server [--resource-location-servers <resource-location-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --resource-location-servers | a list of RFC 887 Resource Location servers available to the client, in order of preference. |

###### root-path

Path name to a TFTP-retrievable file containing vendor-extension information.


    Usage:  ffx net dhcpd set option root-path [--path <path>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --path | the path name to a TFTP-retrievable file. This file contains data which can be interpreted as the BOOTP vendor-extension field. Unlike the BOOTP vendor-extension field, this file has an unconstrained length and any references to Tag 18 are ignored. |

###### router

The routers within a client's subnet.


    Usage:  ffx net dhcpd set option router [--routers <routers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --routers | a list of the routers in a client's subnet, listed in order of preference. |

###### router-solicitation-address

Destination address for Router Solicitation requests.


    Usage:  ffx net dhcpd set option router-solicitation-address [--addr <addr>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addr | the address to which the client should transmit Router Solicitation requests. |

###### smtp-server

SMTP servers available to the client.


    Usage:  ffx net dhcpd set option smtp-server [--smtp-servers <smtp-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --smtp-servers | a list of Simple Mail Transport Protocol (SMTP) server address available to the client, listed in order of preference. |

###### static-route

Static Routes which the client should put in its routing cache.


    Usage:  ffx net dhcpd set option static-route [--routes <routes...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --routes | a list of Destination address/Next-hop address pairs defining static routes for the client's routing table. The routes should be listed in descending order of priority. It is illegal to use 0.0.0.0 as the destination in a static route. |

###### stda-server

StreetTalk Directory Assistance servers available to the client.


    Usage:  ffx net dhcpd set option stda-server [--stda-servers <stda-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --stda-servers | a list of StreetTalk Directory Assistance server addresses available to the client, listed in order of preference. |

###### street-talk-server

StreetTalk servers available to the client.


    Usage:  ffx net dhcpd set option street-talk-server [--streettalk-servers <streettalk-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --streettalk-servers | a list of StreetTalk server addresses available to the client, listed in order of preference. |

###### subnet-mask

The client's subnet mask.


    Usage:  ffx net dhcpd set option subnet-mask [--mask <mask>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --mask | a 32-bit IPv4 subnet mask. |

###### swap-server

Address of the client's swap server.


    Usage:  ffx net dhcpd set option swap-server [--address <address>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --address | the address of the client's swap server. |

###### tcp-default-ttl

Default time-to-live for outgoing TCP segments.


    Usage:  ffx net dhcpd set option tcp-default-ttl [--ttl <ttl>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ttl | the default time-to-live that the client should use for outgoing TCP segments. The minimum value is 1. |

###### tcp-keepalive-garbage

Flag specifying whether the client should send TCP keepalive messages with an octet of garbage.


    Usage:  ffx net dhcpd set option tcp-keepalive-garbage [--send-garbage]

| **Options** |   |
|---|---|
| --help | display usage information |
| --send-garbage | a flag specifying whether the client should send TCP keepalive messages with an octet of garbage for compatibility with older implementations. |

###### tcp-keepalive-interval

Interval the client should wait before sending a TCP keepalive message.


    Usage:  ffx net dhcpd set option tcp-keepalive-interval [--interval <interval>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --interval | the interval, in seconds, the client should wait before sending a TCP keepalive message. A value of 0 indicates that the client should not send keepalive messages unless specifically requested by an application. |

###### tftp-server-name

TFTP server available to the client.


    Usage:  ffx net dhcpd set option tftp-server-name [--name <name>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the TFTP server name available to the client. This option should be used when the `sname` field has been overloaded to carry options. |

###### time-offset

The client's offset from UTC.


    Usage:  ffx net dhcpd set option time-offset [--offset <offset>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --offset | the client's offset from UTC in seconds. A positive offset is east of the zero meridian, and a negative offset is west of the zero meridian. |

###### time-server

Time Protocol servers available to the client.


    Usage:  ffx net dhcpd set option time-server [--time-servers <time-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --time-servers | a list of time servers available to the client, in order of preference. |

###### trailer-encapsulation

Flag specifying whether the client should negotiate the use of trailers in ARP.


    Usage:  ffx net dhcpd set option trailer-encapsulation [--trailers]

| **Options** |   |
|---|---|
| --help | display usage information |
| --trailers | a flag specifying whether the client negotiate the use of trailers when using ARP, per RFC 893. |

###### vendor-specific-information

Option for exchanging vendor-specific information between the DHCP client and DHCP server.


    Usage:  ffx net dhcpd set option vendor-specific-information [--data <data...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --data | an opaque object of octets for exchanging vendor-specific information. |

###### x-window-system-display-manager

X window System Display Manager systems available to the client.


    Usage:  ffx net dhcpd set option x-window-system-display-manager [--display-servers <display-servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --display-servers | a list of X Window System Display Manager system addresses available to the client, listed in order of preference. |

###### x-window-system-font-server

X Window System Font servers available to the client.


    Usage:  ffx net dhcpd set option x-window-system-font-server [--servers <servers...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --servers | a list of X Window System Font server addresses available to the client, listed in order of preference. |

##### parameter

A secondary command indicating a server parameter argument.


    Usage:  ffx net dhcpd set parameter [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [address-pool](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_parameter_address-pool) | The pool of addresses which the DHCP server manages. |
| [arp-probe](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_parameter_arp-probe) | Enables server behavior where the server ARPs an IP address prior to issuing it in a lease. |
| [bound-device-names](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_parameter_bound-device-names) | The names of the network devices on which the server will listen. |
| [ip-addrs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_parameter_ip-addrs) | The IPv4 addresses to which the server is bound. |
| [lease-length](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_parameter_lease-length) | The duration of leases offered by the server. |
| [permitted-macs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_parameter_permitted-macs) | The client MAC addresses which the server will issue leases to. |
| [statically-assigned-addrs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dhcpd_set_parameter_statically-assigned-addrs) | Addresses in the AddressPool which will only be leased to specified clients. Assigned addresses will be paired with hosts in order, e.g. hosts (A, B, C) and addresses (1, 2, 3) pair as ((A, 1), (B, 2), (C, 3)). |

###### address-pool

The pool of addresses which the DHCP server manages.


    Usage:  ffx net dhcpd set parameter address-pool [--prefix-length <prefix-length>] [--range-start <range-start>] [--range-stop <range-stop>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --prefix-length | the prefix length of the network's subnet mask |
| --range-start | the starting address, inclusive, of the range of addresses which the DHCP server will lease to clients |
| --range-stop | the ending address, inclusive, of the range of addresses which the server will to clients |

###### arp-probe

Enables server behavior where the server ARPs an IP address prior to issuing it in a lease.


    Usage:  ffx net dhcpd set parameter arp-probe [--enabled]

| **Options** |   |
|---|---|
| --help | display usage information |
| --enabled | enables server behavior where the server ARPs an IP address prior to issuing it in a lease. If the server receives a response, the server will mark the address as in-use and try again with a different address. By default, this behavior is disabled. |

###### bound-device-names

The names of the network devices on which the server will listen.


    Usage:  ffx net dhcpd set parameter bound-device-names [names...]

| **Options** |   |
|---|---|
| --help | display usage information |

###### ip-addrs

The IPv4 addresses to which the server is bound.


    Usage:  ffx net dhcpd set parameter ip-addrs [--addrs <addrs...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addrs | a list of IPv4 Addresses to which the server is bound. |

###### lease-length

The duration of leases offered by the server.


    Usage:  ffx net dhcpd set parameter lease-length [--default <default>] [--max <max>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --default | the default lease length, in seconds, to be issued to clients. |
| --max | the maximum lease length value, in seconds, which the server will issue to clients who have requested a specific lease length. With the default value of 0, the max lease length is equivalent to the default lease length. |

###### permitted-macs

The client MAC addresses which the server will issue leases to.


    Usage:  ffx net dhcpd set parameter permitted-macs [--macs <macs...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --macs | the client MAC addresses which the server will issue leases to. By default, the server will not have a permitted MAC list, in which case it will attempt to issue a lease to every client which requests one. If permitted_macs has a non-zero length then the server will only respond to lease requests from clients with a MAC in the list. |

###### statically-assigned-addrs

Addresses in the AddressPool which will only be leased to specified clients. Assigned addresses will be paired with hosts in order, e.g. hosts (A, B, C) and addresses (1, 2, 3) pair as ((A, 1), (B, 2), (C, 3)).


    Usage:  ffx net dhcpd set parameter statically-assigned-addrs [--hosts <hosts...>] [--assigned-addrs <assigned-addrs...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --hosts | hosts which will be leased the addresses reserved by `assigned_addrs`. |
| --assigned-addrs | addresses in the AddressPool which will not be leased to clients. Typically, a network administrator will statically assign these addresses to always-on network devices which should always have the same IP address, such as network printers. |

#### start

A primary command to start the DHCP server.


    Usage:  ffx net dhcpd start

| **Options** |   |
|---|---|
| --help | display usage information |

#### stop

A primary command to stop the DHCP server.


    Usage:  ffx net dhcpd stop

| **Options** |   |
|---|---|
| --help | display usage information |

### dns

commands to control the dns resolver


    Usage:  ffx net dns [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [lookup](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_dns_lookup) | performs dns resolution on the specified hostname |

#### lookup

performs dns resolution on the specified hostname


    Usage:  ffx net dns lookup [--ipv4 <ipv4>] [--ipv6 <ipv6>] [--sort <sort>] hostname

| **Options** |   |
|---|---|
| --help | display usage information |
| --ipv4 | include ipv4 results (defaults to true) |
| --ipv6 | include ipv6 results (defaults to true) |
| --sort | sort addresses in order of preference (defaults to true) |

### filter

commands for configuring packet filtering


    Usage:  ffx net filter [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [create](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create) | A command to create new filtering resources |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_list) | A command to list filtering configuration. |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_remove) | A command to remove existing filtering resources |

#### create

A command to create new filtering resources


    Usage:  ffx net filter create --controller <controller> [--idempotent] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --controller | the name of the controller to create (or connect to, if existing) |
| --idempotent | whether the resource creation should be idempotent, i.e. succeed even if the resource already exists |

| **Subcommands** |   |
|---|---|
| [namespace](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_namespace) | A command to specify a filtering namespace |
| [routine](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_routine) | A command to specify a filtering routine |
| [rule](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_rule) | A command to specify a filtering rule |

##### namespace

A command to specify a filtering namespace


    Usage:  ffx net filter create namespace --name <name> [--domain <domain>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the name of the namespace |
| --domain | the IP domain of the namespace |

##### routine

A command to specify a filtering routine


    Usage:  ffx net filter create routine --namespace <namespace> --name <name> --type <type> [--hook <hook>] [--priority <priority>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --namespace | the namespace that contains the routine |
| --name | the name of the routine |
| --type | the type of the routine (IP or NAT) |
| --hook | the hook on which the routine is installed (optional) |
| --priority | the priority of the routine on its hook (optional) |

##### rule

A command to specify a filtering rule


    Usage:  ffx net filter create rule --namespace <namespace> --routine <routine> --index <index> [--in-interface <in-interface>] [--out-interface <out-interface>] [--src-addr <src-addr>] [--dst-addr <dst-addr>] [--transport-protocol <transport-protocol>] [--src-port <src-port>] [--dst-port <dst-port>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --namespace | the namespace that contains the rule |
| --routine | the routine that contains the rule |
| --index | the index of the rule |
| --in-interface | a matcher for the ingress interface of the packet (optional) Accepted formats are any of "id:" |
| --out-interface | a matcher for the egress interface of the packet (optional) Accepted formats are any of "id:" |
| --src-addr | a matcher for the source address of the packet (optional) Accepted formats are any of "subnet:" |
| --dst-addr | a matcher for the destination address of the packet (optional) Accepted formats are any of "subnet:" |
| --transport-protocol | a matcher for the transport protocol of the packet (optional) Accepted protocols are "tcp" |
| --src-port | a matcher for the source port of the packet (optional) Must be accompanied by a transport protocol matcher for either TCP or UDP. Accepted format is "..=". Can be prefixed with a `!` for inverse match. |
| --dst-port | a matcher for the destination port of the packet (optional) Must be accompanied by a transport protocol matcher for either TCP or UDP. Accepted format is "..=". Can be prefixed with a `!` for inverse match. |

| **Subcommands** |   |
|---|---|
| [accept](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_rule_accept) | The `fuchsia.net.filter/Action.Accept` action. |
| [drop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_rule_drop) | The `fuchsia.net.filter/Action.Drop` action. |
| [jump](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_rule_jump) | The `fuchsia.net.filter/Action.Jump` action. |
| [masquerade](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_rule_masquerade) | The `fuchsia.net.filter/Action.Masquerade` action. The source port range to use to rewrite the packet is optional, but --min-src-port and --max-src-port must either both be specified, or neither. |
| [redirect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_rule_redirect) | The `fuchsia.net.filter/Action.Redirect` action. The destination port range to which to redirect the packet is optional, but --min-dst-port and --max-dst-port must either both be specified, or neither. |
| [return](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_rule_return) | The `fuchsia.net.filter/Action.Return` action. |
| [tproxy](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_create_rule_tproxy) | The `fuchsia.net.filter/Action.TransparentProxy` action. Both --addr and --port are optional, but at least one must be specified. |

###### accept

The `fuchsia.net.filter/Action.Accept` action.


    Usage:  ffx net filter create rule accept

| **Options** |   |
|---|---|
| --help | display usage information |

###### drop

The `fuchsia.net.filter/Action.Drop` action.


    Usage:  ffx net filter create rule drop

| **Options** |   |
|---|---|
| --help | display usage information |

###### jump

The `fuchsia.net.filter/Action.Jump` action.


    Usage:  ffx net filter create rule jump target

| **Options** |   |
|---|---|
| --help | display usage information |

###### masquerade

The `fuchsia.net.filter/Action.Masquerade` action. The source port range to use to rewrite the packet is optional, but --min-src-port and --max-src-port must either both be specified, or neither.


    Usage:  ffx net filter create rule masquerade [--src-port <src-port>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --src-port | the source port range used to rewrite the packet (optional) |

###### redirect

The `fuchsia.net.filter/Action.Redirect` action. The destination port range to which to redirect the packet is optional, but --min-dst-port and --max-dst-port must either both be specified, or neither.


    Usage:  ffx net filter create rule redirect [--dst-port <dst-port>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --dst-port | the destination port range used to rewrite the packet (optional) |

###### return

The `fuchsia.net.filter/Action.Return` action.


    Usage:  ffx net filter create rule return

| **Options** |   |
|---|---|
| --help | display usage information |

###### tproxy

The `fuchsia.net.filter/Action.TransparentProxy` action. Both --addr and --port are optional, but at least one must be specified.


    Usage:  ffx net filter create rule tproxy [--addr <addr>] [--port <port>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --addr | the bound address of the local socket to redirect the packet to (optional) |
| --port | the bound port of the local socket to redirect the packet to (optional, must be nonzero) |

#### list

A command to list filtering configuration.


    Usage:  ffx net filter list

| **Options** |   |
|---|---|
| --help | display usage information |

#### remove

A command to remove existing filtering resources


    Usage:  ffx net filter remove --controller <controller> [--idempotent] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --controller | the name of the controller that owns the resource |
| --idempotent | whether the resource removal should be idempotent, i.e. succeed even if the resource does not exist |

| **Subcommands** |   |
|---|---|
| [namespace](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_remove_namespace) | A command to identify a filtering namespace |
| [routine](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_remove_routine) | A command to identify a filtering routine |
| [rule](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_filter_remove_rule) | A command to identify a filtering rule |

##### namespace

A command to identify a filtering namespace


    Usage:  ffx net filter remove namespace --name <name>

| **Options** |   |
|---|---|
| --help | display usage information |
| --name | the name of the namespace |

##### routine

A command to identify a filtering routine


    Usage:  ffx net filter remove routine --namespace <namespace> --name <name>

| **Options** |   |
|---|---|
| --help | display usage information |
| --namespace | the namespace that contains the routine |
| --name | the name of the routine |

##### rule

A command to identify a filtering rule


    Usage:  ffx net filter remove rule --namespace <namespace> --routine <routine> --index <index>

| **Options** |   |
|---|---|
| --help | display usage information |
| --namespace | the namespace that contains the rule |
| --routine | the routine that contains the rule |
| --index | the index of the rule |

### if

commands for network interfaces


    Usage:  ffx net if [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_add) | add interfaces |
| [addr](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_addr) | commands for updating network interface addresses |
| [config](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_config) | get or set interface configuration |
| [disable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_disable) | disables a network interface |
| [enable](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_enable) | enables a network interface |
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_get) | queries a network interface |
| [igmp](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_igmp) | get or set IGMP configuration |
| [ip-forward](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_ip-forward) | get or set IP forwarding for an interface |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_list) | lists network interfaces (supports ffx machine output) |
| [mld](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_mld) | get or set MLD configuration |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_remove) | remove interfaces |

#### add

add interfaces


    Usage:  ffx net if add [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [blackhole](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_add_blackhole) | add a blackhole interface |

##### blackhole

add a blackhole interface


    Usage:  ffx net if add blackhole name

| **Options** |   |
|---|---|
| --help | display usage information |

#### addr

commands for updating network interface addresses


    Usage:  ffx net if addr [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_addr_add) | adds an address to the network interface |
| [del](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_addr_del) | deletes an address from the network interface |
| [wait](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_addr_wait) | waits for an address to be assigned on the network interface. by default waits for any address; if --ipv6 is specified, waits for an IPv6 address. |

##### add

adds an address to the network interface


    Usage:  ffx net if addr add [--no-subnet-route] nicid or name:ifname addr prefix

| **Options** |   |
|---|---|
| --help | display usage information |
| --no-subnet-route | skip adding a local subnet route for this interface and address |

##### del

deletes an address from the network interface


    Usage:  ffx net if addr del nicid or name:ifname addr [prefix]

| **Options** |   |
|---|---|
| --help | display usage information |

##### wait

waits for an address to be assigned on the network interface. by default waits for any address; if --ipv6 is specified, waits for an IPv6 address.


    Usage:  ffx net if addr wait [--ipv6] nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |
| --ipv6 | wait for an IPv6 address |

#### config

get or set interface configuration


    Usage:  ffx net if config [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_config_get) | get interface configuration |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_config_set) | set interface configuration |

##### get

get interface configuration


    Usage:  ffx net if config get

| **Options** |   |
|---|---|
| --help | display usage information |

##### set

set interface configuration

Configuration parameters and the values to be set to should be passed
in pairs. The names of the configuration parameters are taken from
the structure of fuchsia.net.interfaces.admin/Configuration.

The list of supported parameters are:
ipv6.ndp.slaac.temporary_address_enabled
bool
Whether temporary addresses should be generated.
ipv6.ndp.dad.transmits
u16
Number of DAD transmissions before an address is considered available for use.
ipv6.ndp.router_solicitations.max
u8
Maximum number of Router Solicitations to send.


    Usage:  ffx net if config set [options...]

| **Options** |   |
|---|---|
| --help | display usage information |

#### disable

disables a network interface


    Usage:  ffx net if disable nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |

#### enable

enables a network interface


    Usage:  ffx net if enable nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |

#### get

queries a network interface


    Usage:  ffx net if get nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |

#### igmp

get or set IGMP configuration


    Usage:  ffx net if igmp [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_igmp_get) | get IGMP configuration for an interface |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_igmp_set) | set IGMP configuration for an interface |

##### get

get IGMP configuration for an interface


    Usage:  ffx net if igmp get nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |

##### set

set IGMP configuration for an interface


    Usage:  ffx net if igmp set [--version <version>] nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |
| --version | the version of IGMP to perform. |

#### ip-forward

get or set IP forwarding for an interface


    Usage:  ffx net if ip-forward [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_ip-forward_get) | get IP forwarding for an interface |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_ip-forward_set) | set IP forwarding for an interface |

##### get

get IP forwarding for an interface


    Usage:  ffx net if ip-forward get nicid or name:ifname ip_version

| **Options** |   |
|---|---|
| --help | display usage information |

##### set

set IP forwarding for an interface


    Usage:  ffx net if ip-forward set nicid or name:ifname ip_version enable

| **Options** |   |
|---|---|
| --help | display usage information |

#### list

lists network interfaces (supports ffx machine output)


    Usage:  ffx net if list [name_pattern]

| **Options** |   |
|---|---|
| --help | display usage information |

#### mld

get or set MLD configuration


    Usage:  ffx net if mld [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_mld_get) | get MLD configuration for an interface |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_if_mld_set) | set MLD configuration for an interface |

##### get

get MLD configuration for an interface


    Usage:  ffx net if mld get nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |

##### set

set MLD configuration for an interface


    Usage:  ffx net if mld set [--version <version>] nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |
| --version | the version of MLD to perform. |

#### remove

remove interfaces


    Usage:  ffx net if remove nicid or name:ifname

| **Options** |   |
|---|---|
| --help | display usage information |

### log

commands for logging


    Usage:  ffx net log [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [set-packets](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_log_set-packets) | log packets to stdout |

#### set-packets

log packets to stdout


    Usage:  ffx net log set-packets enabled

| **Options** |   |
|---|---|
| --help | display usage information |

### neigh

commands for neighbor tables


    Usage:  ffx net neigh [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh_add) | adds an entry to the neighbor table |
| [clear](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh_clear) | removes all entries associated with a network interface from the neighbor table |
| [config](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh_config) | commands for the Neighbor Unreachability Detection configuration |
| [del](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh_del) | removes an entry from the neighbor table |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh_list) | lists neighbor table entries (supports ffx machine output) |
| [watch](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh_watch) | watches neighbor table entries for state changes (supports ffx machine output) |

#### add

adds an entry to the neighbor table


    Usage:  ffx net neigh add nicid or name:ifname ip mac

| **Options** |   |
|---|---|
| --help | display usage information |

#### clear

removes all entries associated with a network interface from the neighbor table


    Usage:  ffx net neigh clear nicid or name:ifname ip_version

| **Options** |   |
|---|---|
| --help | display usage information |

#### config

commands for the Neighbor Unreachability Detection configuration


    Usage:  ffx net neigh config [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh_config_get) | returns the current NUD configuration options for the provided interface |
| [update](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_neigh_config_update) | updates the current NUD configuration options for the provided interface |

##### get

returns the current NUD configuration options for the provided interface


    Usage:  ffx net neigh config get nicid or name:ifname ip_version

| **Options** |   |
|---|---|
| --help | display usage information |

##### update

updates the current NUD configuration options for the provided interface


    Usage:  ffx net neigh config update [--base-reachable-time <base-reachable-time>] nicid or name:ifname ip_version

| **Options** |   |
|---|---|
| --help | display usage information |
| --base-reachable-time | a base duration, in nanoseconds, for computing the random reachable time |

#### del

removes an entry from the neighbor table


    Usage:  ffx net neigh del nicid or name:ifname ip

| **Options** |   |
|---|---|
| --help | display usage information |

#### list

lists neighbor table entries (supports ffx machine output)


    Usage:  ffx net neigh list

| **Options** |   |
|---|---|
| --help | display usage information |

#### watch

watches neighbor table entries for state changes (supports ffx machine output)


    Usage:  ffx net neigh watch

| **Options** |   |
|---|---|
| --help | display usage information |

### route

commands for routing tables


    Usage:  ffx net route [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_route_add) | adds a route to the route table |
| [del](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_route_del) | deletes a route from the route table |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_route_list) | lists routes (supports ffx machine output) |

#### add

adds a route to the route table


    Usage:  ffx net route add --destination <destination> --netmask <netmask or prefix length> [--gateway <gateway>] --nicid <nicid or name:ifname> [--metric <metric>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --destination | the network id of the destination network |
| --netmask | the netmask or prefix length corresponding to destination |
| --gateway | the ip address of the first hop router |
| --nicid | the outgoing network interface of the route |
| --metric | the metric for the route |

#### del

deletes a route from the route table


    Usage:  ffx net route del --destination <destination> --netmask <netmask or prefix length> [--gateway <gateway>] --nicid <nicid or name:ifname> [--metric <metric>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --destination | the network id of the destination network |
| --netmask | the netmask or prefix length corresponding to destination |
| --gateway | the ip address of the first hop router |
| --nicid | the outgoing network interface of the route |
| --metric | the metric for the route |

#### list

lists routes (supports ffx machine output)


    Usage:  ffx net route list

| **Options** |   |
|---|---|
| --help | display usage information |

### rule

commands for policy-based-routing rules


    Usage:  ffx net rule [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_net_rule_list) | lists rules (supports ffx machine output) |

#### list

lists rules (supports ffx machine output)


    Usage:  ffx net rule list

| **Options** |   |
|---|---|
| --help | display usage information |

## package

Create and publish Fuchsia packages


    Usage:  ffx package [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [archive](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_archive) | Archive Fuchsia packages |
| [blob](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_blob) | Work with Fuchsia blob files. |
| [build](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_build) | Builds a package. |
| [far](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_far) | Work with Fuchsia Archive Format (FAR) files |
| [file-hash](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_file-hash) | Compute the merkle tree root hash of one or more files. |
| [ota-manifest](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_ota-manifest) | Inspect or modify OTA Manifests |

### archive

Archive Fuchsia packages


    Usage:  ffx package archive [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_archive_add) | add a file () to an existing package archive (), placing the resulting archive in |
| [cat](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_archive_cat) | write the contents of inside the Fuchsia package archive file to stdout |
| [create](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_archive_create) | create a package archive from a package_manifest.json |
| [edit](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_archive_edit) | edit the metadata of an existing package archive (), placing the resulting archive in |
| [extract](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_archive_extract) | extract the contents of inside the Fuchsia package archive file to the output directory |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_archive_list) | List the contents of Fuchia package archive file |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_archive_remove) | remove a file () from an existing package archive (), placing the resulting archive in |

#### add

add a file () to an existing package archive (), placing the resulting archive in


    Usage:  ffx package archive add -a <archive> -f <file-to-add> -p <path-of-file-in-archive> -o <output> [-w <overwrite>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -a, --archive | package archive |
| -f, --file-to-add | file to add to the package archive |
| -p, --path-of-file-in-archive | the destination path in the archive for |
| -o, --output | the name of the resulting archive. Can be the same as to overwrite |
| -w, --overwrite | if false, refuses to overwrite files in named by |

#### cat

write the contents of inside the Fuchsia package archive file to stdout


    Usage:  ffx package archive cat archive far_path

| **Options** |   |
|---|---|
| --help | display usage information |

#### create

create a package archive from a package_manifest.json


    Usage:  ffx package archive create -o <out> [-r <root-dir>] [--depfile <depfile>] package_manifest

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --out | output package archive |
| -r, --root-dir | root directory for paths in package_manifest.json |
| --depfile | produce a depfile file at the provided path |

#### edit

edit the metadata of an existing package archive (), placing the resulting archive in


    Usage:  ffx package archive edit -a <archive> [--package-name <package-name>] [--unsafe-override-abi-revision <unsafe-override-abi-revision>] -o <output>

| **Options** |   |
|---|---|
| --help | display usage information |
| -a, --archive | package archive |
| --package-name | if specified, change the name of the package (i.e., what appears in meta/package) to . |
| --unsafe-override-abi-revision | if specified, replace the ABI revision in the package. Do not do this unless you're certain you know what you're doing! |
| -o, --output | the name of the resulting archive. Can be the same as to overwrite |

#### extract

extract the contents of inside the Fuchsia package archive file to the output directory


    Usage:  ffx package archive extract [-o <out>] [--repository <repository>] [--blobs-json] [--namespace] archive

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --out | output directory for writing the extracted files. Defaults to the current directory. |
| --repository | repository of the package |
| --blobs-json | produce a blobs.json file |
| --namespace | extract the package namespace into /pkg |

#### list

List the contents of Fuchia package archive file


    Usage:  ffx package archive list [-l] archive

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --long-format | show long information for each entry |

#### remove

remove a file () from an existing package archive (), placing the resulting archive in


    Usage:  ffx package archive remove -a <archive> -f <file-to-remove> -o <output>

| **Options** |   |
|---|---|
| --help | display usage information |
| -a, --archive | package archive |
| -f, --file-to-remove | file to add to the package archive |
| -o, --output | the name of the resulting archive. Can be the same as to overwrite |

### blob

Work with Fuchsia blob files.


    Usage:  ffx package blob [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [compress](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_blob_compress) | Compress one or more blobs |
| [decompress](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_blob_decompress) | Decompress one or more blobs |
| [hash](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_blob_hash) | Compute the merkle tree root hash of one or more delivery blobs or uncompressed blobs. |

#### compress

Compress one or more blobs


    Usage:  ffx package blob compress [-t <type>] -o <output> [--hash-as-name] [paths...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -t, --type | delivery blob type |
| -o, --output | output compressed blobs into this directory |
| --hash-as-name | use the merkle root of each file as its output name |

#### decompress

Decompress one or more blobs


    Usage:  ffx package blob decompress -o <output> [paths...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --output | output decompressed blobs into this directory |

#### hash

Compute the merkle tree root hash of one or more delivery blobs or uncompressed blobs.


    Usage:  ffx package blob hash [-u] [paths...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -u, --uncompressed | blobs are uncompressed instead of delivery blobs |

### build

Builds a package.


    Usage:  ffx package build [-o <out>] --api-level <api-level> [--published-name <published-name>] [--repository <repository>] [--depfile] [--blobs-json] [--blobs-manifest] [--subpackages-build-manifest-path <subpackages-build-manifest-path>] package_build_manifest_path

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --out | directory to save package artifacts |
| --api-level | package API level |
| --published-name | name of the package |
| --repository | repository of the package |
| --depfile | produce a depfile file |
| --blobs-json | produce a blobs.json file |
| --blobs-manifest | produce a blobs.manifest file |
| --subpackages-build-manifest-path | path to the subpackages build manifest file |

### far

Work with Fuchsia Archive Format (FAR) files


    Usage:  ffx package far [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [cat](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_far_cat) | Dump the contents of the entry associated with to stdout |
| [create](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_far_create) | Create a FAR file from a directory. WARNING: this will overwrite if it exists. |
| [extract](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_far_extract) | Extract from to . WARNING: this may overwrite existing files. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_far_list) | List the entry paths contained in a FAR file |

#### cat

Dump the contents of the entry associated with to stdout


    Usage:  ffx package far cat far_file path

| **Options** |   |
|---|---|
| --help | display usage information |

#### create

Create a FAR file from a directory. WARNING: this will overwrite if it exists.


    Usage:  ffx package far create input_directory output_file

| **Options** |   |
|---|---|
| --help | display usage information |

#### extract

Extract from to . WARNING: this may overwrite existing files.


    Usage:  ffx package far extract [-v] [-o <output-dir>] far_file [paths...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --verbose | verbose output: print file names that were extracted |
| -o, --output-dir | output directory (defaults to current directory, creates the directory if it doesn't exist) |

#### list

List the entry paths contained in a FAR file


    Usage:  ffx package far list [-l] far_file

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --long-format | show detailed information for each entry (does nothing if --machine json is specified, which shows everything) |

### file-hash

Compute the merkle tree root hash of one or more files.


    Usage:  ffx package file-hash [paths...]

| **Options** |   |
|---|---|
| --help | display usage information |

### ota-manifest

Inspect or modify OTA Manifests


    Usage:  ffx package ota-manifest [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [generate](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_ota-manifest_generate) | Generate a new OTA Manifest. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_package_ota-manifest_show) | Show the contents of a signed ota-manifest. |

#### generate

Generate a new OTA Manifest.


    Usage:  ffx package ota-manifest generate --target <target> -o <output> [--blob-base-url <blob-base-url>] [--vbmeta <vbmeta>] [--zbi <zbi>] [--key <key>] [--key-signature <key-signature>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --target | path to the target product bundle directory or an existing manifest file |
| -o, --output | output file path for the new manifest |
| --blob-base-url | optional new blob base url |
| --vbmeta | optional vbmeta asset image file to replace the existing one |
| --zbi | optional zbi asset image file to replace the existing one |
| --key | optional manifest private key file (PEM or PKCS8). If not provided, the default dev key is used. |
| --key-signature | optional file containing the signature of the manifest public key. If not provided, the manifest private key is used as root key to sign its own public key. |

#### show

Show the contents of a signed ota-manifest.


    Usage:  ffx package ota-manifest show [--public-key <public-key>] [--print-blobs] manifest

| **Options** |   |
|---|---|
| --help | display usage information |
| --public-key | optional public key file for verifying the manifest signature |
| --print-blobs | whether to print the full list of blobs (default is false outside of machine mode) |

## platform

Manage platform build prerequisites


    Usage:  ffx platform [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [preflight](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_platform_preflight) | Evaluate suitability for building and running Fuchsia |

### preflight

Evaluate suitability for building and running Fuchsia


    Usage:  ffx platform preflight [--json]

| **Options** |   |
|---|---|
| --help | display usage information |
| --json | outputs json instead of human-readable text. |

## power

Control system power features


    Usage:  ffx power [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [collaborative-reboot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_power_collaborative-reboot) | Interact with collaborative reboot |
| [debugcmd](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_power_debugcmd) | Send a debug command to the Power Manager |
| [suspend](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_power_suspend) | Control system suspend behavior |

### collaborative-reboot

Interact with collaborative reboot


    Usage:  ffx power collaborative-reboot [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [perform-pending-reboot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_power_collaborative-reboot_perform-pending-reboot) | Perform a pending Collaborative Reboot, if any. |

#### perform-pending-reboot

Perform a pending Collaborative Reboot, if any.


    Usage:  ffx power collaborative-reboot perform-pending-reboot

| **Options** |   |
|---|---|
| --help | display usage information |

### debugcmd

Send a debug command to the Power Manager


    Usage:  ffx power debugcmd --node-name <node-name> --command <command> [--args <args...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --node-name | name of target node |
| --command | debug command to send |
| --args | arguments for the debug command |

### suspend

Control system suspend behavior


    Usage:  ffx power suspend [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [allow](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_power_suspend_allow) | Allow system to suspend. |
| [prevent](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_power_suspend_prevent) | Prevent system from suspending. |

#### allow

Allow system to suspend.


    Usage:  ffx power suspend allow

| **Options** |   |
|---|---|
| --help | display usage information |

#### prevent

Prevent system from suspending.


    Usage:  ffx power suspend prevent [--restart] [--wait-time <wait-time>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --restart | drop existing lease and re-take it after wait_time. |
| --wait-time | the duration the system waits before starting application activity again (e.g. 100ms, 5s). The system is not guaranteed to start again after this time, but on the next wakeup this command will take a lease on application activity. Defaults to 100ms. |

## process

Processes related commands


    Usage:  ffx process [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [filter](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_process_filter) | outputs information about the processes that correspond to the koids input |
| [generate-fuchsia-map](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_process_generate-fuchsia-map) | outputs the json required to generate a map of all processes and channels |
| [kill](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_process_kill) | Attempts to kill a process by it's KOID or process name. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_process_list) | outputs a list containing the name and koid of all processes |
| [stack_trace](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_process_stack_trace) | Attempts to get a strack trace a process by it's KOID or process name. |
| [tree](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_process_tree) | outputs the tree of all tasks in the system |

### filter

outputs information about the processes that correspond to the koids input


    Usage:  ffx process filter [process_koids...]

| **Options** |   |
|---|---|
| --help | display usage information |

### generate-fuchsia-map

outputs the json required to generate a map of all processes and channels


    Usage:  ffx process generate-fuchsia-map

| **Options** |   |
|---|---|
| --help | display usage information |

### kill

Attempts to kill a process by it's KOID or process name.


    Usage:  ffx process kill task_to_kill

| **Options** |   |
|---|---|
| --help | display usage information |

### list

outputs a list containing the name and koid of all processes


    Usage:  ffx process list [--verbose]

| **Options** |   |
|---|---|
| --help | display usage information |
| --verbose | outputs all processes and the kernel objects owned by each of them |

### stack_trace

Attempts to get a strack trace a process by it's KOID or process name.


    Usage:  ffx process stack_trace task

| **Options** |   |
|---|---|
| --help | display usage information |

### tree

outputs the tree of all tasks in the system


    Usage:  ffx process tree [--threads]

| **Options** |   |
|---|---|
| --help | display usage information |
| --threads | include threads |

## product

Discover and access product bundle metadata and image data.


    Usage:  ffx product [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [create-old](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_create-old) | Create a Product Bundle using the outputs of Product Assembly. |
| [download](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_download) | Download Product Bundle from GCS. |
| [extract-blobs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_extract-blobs) | Extract all blobs from a product bundle to a target directory. |
| [get-artifacts](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_get-artifacts) | Get the paths of a group of artifacts inside a Product Bundle. |
| [get-image-path](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_get-image-path) | Get the path of an image inside a Product Bundle based on type and slot. |
| [get-repository](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_get-repository) | Get the info of repository inside a Product Bundle. |
| [get-version](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_get-version) | Get the product version of a Product Bundle. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_list) | List all available products for a specific SDK version. |
| [lookup](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_lookup) | Retrieve image data. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product_show) | Display a list of details from within a product bundle. |

### create-old

Create a Product Bundle using the outputs of Product Assembly.


    Usage:  ffx product create-old --product-name <product-name> [--system-a <system-a>] [--system-b <system-b>] [--system-r <system-r>] [--tuf-keys <tuf-keys>] [--update-package-version-file <update-package-version-file>] [--update-package-epoch <update-package-epoch>] [--virtual-device <virtual-device...>] [--recommended-device <recommended-device>] --out-dir <out-dir> [--delivery-blob-type <delivery-blob-type>] [--with-deprecated-flash-manifest] [--gerrit-size-report <gerrit-size-report>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-name | product.board label. e.g. "workstation_eng.x64". |
| --system-a | path to an assembly manifest, which specifies images to put in slot A. |
| --system-b | path to an assembly manifest, which specifies images to put in slot B. |
| --system-r | path to an assembly manifest, which specifies images to put in slot R. |
| --tuf-keys | path to the directory of TUF keys, which should include root.json, snapshot.json, targets.json, and timestamp.json. If provided, then a TUF repository will be created inside the product bundle and filled with the product blobs. |
| --update-package-version-file | file containing the version of the Product to put in the update package. |
| --update-package-epoch | backstop OTA version. Fuchsia will reject updates with a lower epoch. |
| --virtual-device | path to a Virtual Device Specification file to include in the product bundle. May be repeated to include multiple Virtual Devices. |
| --recommended-device | name of a Virtual Device Specification file to mark as the "recommended" device for emulation. |
| --out-dir | directory to write the product bundle. |
| --delivery-blob-type | the type of delivery blob the product needs. |
| --with-deprecated-flash-manifest | create a deprecated flash manifest for backward compatibility. |
| --gerrit-size-report | an optional image size report to generate that indicates the sizes of the images when mapped to partitions. |

### download

Download Product Bundle from GCS.


    Usage:  ffx product download [--force] [--auth <auth>] [--base-url <base-url>] [--version <version>] [--branch <branch>] manifest_url product_dir

| **Options** |   |
|---|---|
| --help | display usage information |
| --force | get the data again, even if it's already present locally. |
| --auth | use specific auth flow for oauth2 (see examples; default: pkce). |
| --base-url | location to look for product bundles manifest inside GCS. |
| --version | filter on products of . The version number is in the format of `a.b.c.d`. e.g. 19.20240302.2.1. If this value is not passed in, the version will be defaulted to version of ffx tool itself. |
| --branch | filter on products of . The branch is either in the form of f (e.g. f18) or `LATEST`. This option is exclusive with version option. |

**Examples**

```
Sample invocations:

    // Download core.vim3 based on current ffx version. Note it will download
    // the latest version of the date section.
    ffx product download core.vim3 ~/local_pb

    // Download core.vim3 with version 19.20240302.2.1
    ffx product download core.vim3 ~/local_pb --version 19.20240302.2.1

    // Download core.vim3 for latest version of f18
    ffx product download core.vim3 ~/local_pb --branch f18 --force

    Auth flow choices for --auth include:

      `--auth no-auth` do not use auth.
      `--auth pkce` to use PKCE auth flow (requires GUI browser).
      `--auth device-experimental` to use device flow.
      `--auth ` run tool at given path which will print an access
        token to stdout and exit 0.
      `--auth default` let the tool decide which auth flow to use.
    
```

### extract-blobs

Extract all blobs from a product bundle to a target directory.


    Usage:  ffx product extract-blobs [-p <product-bundle>] -o <out-dir> [-s <slot>] [-d <delivery-blob-type>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -p, --product-bundle | path to the product bundle directory (optional, queries configuration if not set). |
| -o, --out-dir | path to the output directory where the blobs will be extracted. |
| -s, --slot | slot to extract from (defaults to A). |
| -d, --delivery-blob-type | specify the delivery blob type to compress extracted blobs to. If not specified, raw uncompressed blobs are returned. |

### get-artifacts

Get the paths of a group of artifacts inside a Product Bundle.


    Usage:  ffx product get-artifacts -g <artifacts-group> [-r] [product_bundle]

| **Options** |   |
|---|---|
| --help | display usage information |
| -g, --artifacts-group | select what group of artifacts to list. One of flash, emu, update, bootloader, all |
| -r, --relative-path | return relative path or not |

### get-image-path

Get the path of an image inside a Product Bundle based on type and slot.


    Usage:  ffx product get-image-path [--slot <slot>] [--image-type <image-type>] [-b <bootloader>] [-r] [product_bundle]

| **Options** |   |
|---|---|
| --help | display usage information |
| --slot | the slot where image will be located in. Valid slots are A,B,R. |
| --image-type | the type of image. Supported types are zbi, vbmeta, fvm, fxfs.fastboot, qemu-kernel, or dtbo. |
| -b, --bootloader | the type of bootloader. |
| -r, --relative-path | return relative path or not |

### get-repository

Get the info of repository inside a Product Bundle.


    Usage:  ffx product get-repository product_bundle

| **Options** |   |
|---|---|
| --help | display usage information |

### get-version

Get the product version of a Product Bundle.


    Usage:  ffx product get-version [--include-dependencies] artifact

| **Options** |   |
|---|---|
| --help | display usage information |
| --include-dependencies | when true, return version info for all included assembly artifacts. |

### list

List all available products for a specific SDK version.


    Usage:  ffx product list [--auth <auth>] [--base-url <base-url>] [--version <version>] [--branch <branch>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --auth | use specific auth flow for oauth2 (see examples; default: pkce). |
| --base-url | location to look for product bundles manifest inside GCS. |
| --version | filter on products of . The version number is in the format of `a.b.c.d`. e.g. 19.20240302.2.1. If this value is not passed in, the version will be defaulted to version of ffx tool itself. |
| --branch | filter on products of . The branch is either in the form of f (e.g. f18) or `LATEST`. This option is exclusive with version option. |

**Examples**

```
Sample invocations:

    // List all product names based on current ffx version. Note it will list
    // the latest version of the date section.
    ffx product list

    // List all product names with version 19.20240302.2.1
    ffx product list --version 19.20240302.2.1

    // List all product names for latest version of f18
    ffx product list --branch f18

    Auth flow choices for --auth include:

      `--auth no-auth` do not use auth.
      `--auth pkce` to use PKCE auth flow (requires GUI browser).
      `--auth device-experimental` to use device flow.
      `--auth ` run tool at given path which will print an access
        token to stdout and exit 0.
      `--auth default` let the tool decide which auth flow to use.
    
```

### lookup

Retrieve image data.


    Usage:  ffx product lookup [--auth <auth>] [--base-url <base-url>] name version

| **Options** |   |
|---|---|
| --help | display usage information |
| --auth | use specific auth flow for oauth2 (see examples; default: pkce). |
| --base-url | where to look for product bundles manifest. |

**Examples**

```
Auth flow choices for --auth include:
  `--auth oob` to use Out-of-Band auth (deprecated).
  `--auth pkce` to use PKCE auth flow (requires GUI browser).
  `--auth ` run tool at given path which will print an access token to stdout and exit 0.
    
```

### show

Display a list of details from within a product bundle.


    Usage:  ffx product show [--devices] [--device <device>] product_bundle_path

| **Options** |   |
|---|---|
| --help | display usage information |
| --devices | list the virtual devices linked to this product bundle. |
| --device | print the details of a virtual device linked to this product bundle. |

## product-bundle

Manage product bundles. NOTE: 'list' and 'get' have been moved to 'ffx product'


    Usage:  ffx product-bundle [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [bisect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product-bundle_bisect) | Generate a list of released versions between \[--from-success\] and \[--to-failure\] for every artifact contained within the given product bundle (e.g. platform, product, board). Assemble intermediate product bundles using combinations of the artifacts, and facilitate running tests on those PBs to quickly identify which artifact is the source of a bug or behavior change. |
| [create](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_product-bundle_create) | Construct a product bundle using a platform, product config, and board config. |

### bisect

Generate a list of released versions between \[--from-success\] and \[--to-failure\] for every artifact contained within the given product bundle (e.g. platform, product, board). Assemble intermediate product bundles using combinations of the artifacts, and facilitate running tests on those PBs to quickly identify which artifact is the source of a bug or behavior change.


    Usage:  ffx product-bundle bisect --from-success <from-success> --to-failure <to-failure> [--slot <slot>] [--out-dir <out-dir>] [--gen-dir <gen-dir>] [--script <script>] [--auth <auth>] name

| **Options** |   |
|---|---|
| --help | display usage information |
| --from-success | known-good version of the product bundle. The bisection search window begins here. |
| --to-failure | known-bad version of the product bundle. The bisection search window ends here. |
| --slot | slot to bisect over (a or r). Defaults to slot A. |
| --out-dir | directory to write assembled images and other artifacts. Defaults to \~//out |
| --gen-dir | directory to write intermediate files. Defaults to \~//gen |
| --script | script to run for automated bisection. |
| --auth | authentication method to use. |

**Examples**

```
// 1. Bisect the core.vim3 product bundle between two provided versions.
// (Note: core.vim3 is not yet supported: https://fxbug.dev/485981469 .)

ffx product-bundle bisect core.vim3 \
    --from-success 29.20250826.6.1 \
    --to-failure 29.20250905.6.1


// 2. Automate bisection with a validation script.
// Create a file called `validate.sh` with the following content:

#!/bin/bash
# Extract the PB path from the arguments
while \[\[ "$#" -gt 0 ]]; do
    case $1 in
        --pb) PB_PATH="$2"; shift 2 ;;
        *) shift ;;
    esac
done

# Flash the device with the assembled product bundle
ffx target flash "$PB_PATH"
if \[ $? -ne 0 ]; then
    echo "Failed to flash, skipping..."
    exit 128 # Infrastructure failure
fi

# 
# e.g., ffx test run ...

# Return 0 for Pass, 1 for Fail
exit 0

// Then pass the script to the bisection tool:
ffx product-bundle bisect core.vim3 \
    --from-success 29.20250826.6.1 \
    --to-failure 29.20250905.6.1 \
    --script ./validate.sh
    
```

**Notes**

-

  ```
  VERSION formats:
  This parameter type (from-success, to-failure) refers to the product bundle version.

  Steps to retrieve this information depends on which product bundle is being bisected,
  but it can always be retrieved from the product bundle itself by running:

  ffx product-bundle get-version 
  ```
-

  ```
  For more information about how to use this tool, see go/fuchsia-product-bisection-userguide
  ```
-

  ```
  VALIDATION SCRIPT REQUIREMENTS:
  If a --script is provided, it will be executed for each bisection step.
  The script will receive the following arguments:
  --pb   : The absolute path to the assembled product bundle for the current step.

  The script must exit with one of the following codes:
  0          : Pass (The bug is NOT present in this version)
  1-127      : Fail (The bug IS present in this version)
  128+       : Infrastructure failure (A critical infrastructure failure occurred)
  ```

### create

Construct a product bundle using a platform, product config, and board config.


    Usage:  ffx product-bundle create [--platform <platform>] [--product-config <product-config>] [--recovery-product-config <recovery-product-config>] [--board-config <board-config>] [--recovery-board-config <recovery-board-config>] [--bib-set <bib-set...>] [--pib <pib...>] [--output-name <output-name>] [--tuf-keys <tuf-keys>] [--stage] [--developer-overrides <developer-overrides>] [--out <out>] [--auth <auth>] [--zbi-only] [product_config_board_config_combo]

| **Options** |   |
|---|---|
| --help | display usage information |
| --platform | the platform artifacts to use. See PLATFORM_ARTIFACT below. |
| --product-config | the product config to use. See ARTIFACT below. |
| --recovery-product-config | path to the product config to use for the recovery image. |
| --board-config | the board config to use. See ARTIFACT below. |
| --recovery-board-config | the board config to use for the recovery image. |
| --bib-set | the board input bundle sets (bib_sets) to use. See ARTIFACT below. |
| --pib | the product input bundles (pibs) to use. See ARTIFACT below. |
| --output-name | the name to add to the output product bundle. Defaults to product_config.board_config. |
| --tuf-keys | the tuf keys to use. |
| --stage | prepare the assembly inputs, but do not run assembly yet. |
| --developer-overrides | path to a file specifying developer-level overrides for assembly. |
| --out | the location to write the product bundle to. |
| --auth | authentication method to use. |
| --zbi-only | only build the ZBI and copy it to the top level of the output directory. |

**Examples**

```
// Create a minimal.arm64 product bundle in a local fuchsia checkout.
ffx product-bundle create --product-config minimal --board-config arm64

// This is shorthand for the above command.
ffx product-bundle create minimal.arm64
    
```

```
// Create a minimal.arm64 product bundle using prebuilts in CIPD.
ffx product-bundle create \
    --platform 29.20250826.6.1 \
    --product-config minimal \
    --board-config cipd://fuchsia/assembly/boards/arm64@29.20250826.6.1
    
```

```
// Create a minimal.vim3 product bundle using a board config from MOS.
ffx product-bundle create \
    --platform 29.20250826.6.1 \
    --product-config minimal \
    --board-config mos://fuchsia/boards/vim3@29.20250916.6.1
    
```

**Notes**

-

  ```
  PLATFORM_ARTIFACT formats:
  : in a fuchsia checkout, use locally built platform

  latest: use latest prebuilt platform from CIPD

  29.20250812.4.1: version of a prebuilt platform in
  https://chrome-infra-packages.appspot.com/p/fuchsia/assembly/platform/

  path/to/platform: local path to a platform
  ```
-

  ```
  ARTIFACT formats:
  : in a fuchsia checkout, use locally built artifact by its name

  cipd://@: cipd url for a prebuilt artifact.
  `latest` can be used as  to fetch the newest artifact.

  path/to/artifact: a path to a locally built artifact
  ```

## profile

Profile run-time information from various subsystems


    Usage:  ffx profile [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [cpu](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_cpu) | Query CPU-related information |
| [gpu](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_gpu) | Access GPU usage information |
| [heapdump](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_heapdump) | Profile and dump heap memory usage |
| [memory](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_memory) | Query memory related information |
| [network](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_network) | Access network activity information |
| [power](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_power) | Access power-related information |
| [stacktrack](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_stacktrack) | Dump stack traces |
| [temperature](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_temperature) | Access temperature-related information |

### cpu

Query CPU-related information


    Usage:  ffx profile cpu [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [load](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_cpu_load) | Collect and print CPU usage data for the specified time frame, or instruct the metrics-logger component to record the CPU usage data to Inspect, Trace, and/or syslog. |

#### load

Collect and print CPU usage data for the specified time frame, or instruct the metrics-logger component to record the CPU usage data to Inspect, Trace, and/or syslog.


    Usage:  ffx profile cpu load [-d <duration>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -d, --duration | duration over which to measure and print the CPU load |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_cpu_load_start) | Start logging on the target |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_cpu_load_stop) | Stop logging on the target |

**Examples**

```
1) To measure the CPU load over a two second duration:

    $ ffx profile cpu load --duration 2s

    The measured CPU load from each core is printed in the following format:

        CPU 0: 0.66%
        CPU 1: 1.56%
        CPU 2: 0.83%
        CPU 3: 0.71%
        Total: 3.76%

    The valid range for each CPU load is \[0-100]%. The "Total" value represents the summation of the load percentages of all CPU cores and is valid in the range \[0-100*\[NUM_CPU]]%.

2) To log CPU load every 500 ms indefinitely:

    $ ffx profile cpu load start --interval 500ms

    Logged samples will be available via iquery under core/metrics-logger and via tracing in the `metrics_logger` category.

3) To log CPU load every 1 second for 30 seconds with output-to-syslog enabled:

    $ ffx profile cpu load start --interval 1s -d 30s --output-to-syslog

    Logged samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category.
```

**Notes**

-

      Please specify a duration for immediate load display, or alternatively, utilize the start/stop subcommand to instruct the metrics-logger component to record the CPU usage data to Inspect, Trace, and/or syslog.
      If the metrics-logger component is not available to the target, add --with //src/power/metrics-logger to fx set.

##### start

Start logging on the target


    Usage:  ffx profile cpu load start -s <interval> [--output-to-syslog] [-d <duration>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --interval | interval for logging the CPU load |
| --output-to-syslog | toggle for logging CPU loads to syslog |
| -d, --duration | duration for which to log; if omitted, logging will continue indefinitely |

##### stop

Stop logging on the target


    Usage:  ffx profile cpu load stop

| **Options** |   |
|---|---|
| --help | display usage information |

### gpu

Access GPU usage information


    Usage:  ffx profile gpu [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [usage](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_gpu_usage) | Controls the metrics-logger component to log gpu usage. Logged samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category. |

#### usage

Controls the metrics-logger component to log gpu usage. Logged samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category.


    Usage:  ffx profile gpu usage [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_gpu_usage_start) | Start logging on the target |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_gpu_usage_stop) | Stop logging on the target |

**Examples**

```
To poll gpu usage every 500 ms indefinitely:

    $ ffx profile gpu usage start --interval 500ms

To poll gpu driver every 1 second for 30 seconds with output-to-syslog enabled:

    $ ffx profile gpu usage start --interval 1s -d 30s --output-to-syslog
```

**Notes**

-

  ```
  If the metrics-logger component is not available to the target, then this command will not work
  properly. Add --with //src/power/metrics-logger to fx set.
  ```

##### start

Start logging on the target


    Usage:  ffx profile gpu usage start -s <interval> [--output-to-syslog] [-d <duration>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --interval | interval for polling the GPU driver |
| --output-to-syslog | toggle for logging samples to syslog |
| -d, --duration | duration for which to log; if omitted, logging will continue indefinitely |

##### stop

Stop logging on the target


    Usage:  ffx profile gpu usage stop

| **Options** |   |
|---|---|
| --help | display usage information |

### heapdump

Profile and dump heap memory usage


    Usage:  ffx profile heapdump [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [download](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_heapdump_download) | Download stored snapshot |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_heapdump_list) | List stored snapshots |
| [snapshot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_heapdump_snapshot) | Snapshot current heap memory usage |

#### download

Download stored snapshot


    Usage:  ffx profile heapdump download [--collector <collector>] --snapshot-id <snapshot-id> [--with-tags] --output-file <output-file> [--symbolize]

| **Options** |   |
|---|---|
| --help | display usage information |
| --collector | moniker of the collector to be queried (default: autodetect) |
| --snapshot-id | snapshot ID to be downloaded |
| --with-tags | write per-block metadata (as tags) in the protobuf file |
| --output-file | output compressed protobuf file (extension: .pb.gz) |
| --symbolize | symbolize the generated profile |

#### list

List stored snapshots


    Usage:  ffx profile heapdump list [--collector <collector>] [--by-name <by-name>] [--by-koid <by-koid>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --collector | moniker of the collector to be queried (default: autodetect) |
| --by-name | select process by name |
| --by-koid | select process by koid |

#### snapshot

Snapshot current heap memory usage


    Usage:  ffx profile heapdump snapshot [--collector <collector>] [--by-name <by-name>] [--by-koid <by-koid>] --output-file <output-file> [--with-tags] [--output-contents-dir <output-contents-dir>] [--symbolize] [--multi-process]

| **Options** |   |
|---|---|
| --help | display usage information |
| --collector | moniker of the collector to be queried (default: autodetect) |
| --by-name | select process by name |
| --by-koid | select process by koid |
| --output-file | output compressed protobuf file (extension: .pb.gz) |
| --with-tags | write per-block metadata (as tags) in the protobuf file |
| --output-contents-dir | optional directory to dump each blocks' contents into |
| --symbolize | symbolize the generated profile |
| --multi-process | allow selecting more than one process |

### memory

Query memory related information


    Usage:  ffx profile memory [--debug-json] [--process-koids <process-koids...>] [--process-names <process-names...>] [--interval <interval>] [--buckets] [--undigested] [--csv] [--exact-sizes] [--stdin-input] [--backend <backend>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --debug-json | outputs the json returned by memory_monitor. For debug purposes only, no guarantee is made on the stability of the output of this command. |
| --process-koids | filters by process koids. Repeatable flag. |
| --process-names | filters by process names (exact match). Repeatable flag. |
| --interval | repeats the command at the given interval (in seconds) until terminated. |
| --buckets | prints a bucketized digest of the memory usage. |
| --undigested | displays the detailed view of only the undigested memory (memory not part of any bucket) instead of the full memory. |
| --csv | outputs csv that for every process shows the device uptime in seconds, the process koid, the process name, and the private, scale, and total memory usage. This option is not supported with other output options like --machine. |
| --exact-sizes | outputs the exact byte sizes, as opposed to a human-friendly format. Does not impact machine oriented outputs, such as CSV and JSON outputs. |
| --stdin-input | loads the unprocessed memory information as json from stdin. |
| --backend | selects where to read the memory information from. 'default', 'memory_monitor_1', or 'memory_monitor_2' are supported. |

| **Subcommands** |   |
|---|---|
| [components](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_memory_components) | Components. |
| [signal](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_memory_signal) | Signals userspace clients with specified memory pressure level. Clients can use this command to test their response to memory pressure. Does not affect the real memory pressure level on the system, or trigger any kernel reclamation tasks. |

#### components

Components.


    Usage:  ffx profile memory components [--stdin-input] [--debug-json] [--csv] [-b] [-l] [--detailed] [--stats-only <stats-only>] [--assembly-manifest <assembly-manifest>] [--abridged]

| **Options** |   |
|---|---|
| --help | display usage information |
| --stdin-input | loads the unprocessed memory information as json from stdin. |
| --debug-json | outputs the unprocessed memory information from the device as json. |
| --csv | outputs data in csv format. |
| -b, --buckets | prints a bucketized digest of the memory usage. |
| -l, --list-vmos | used in conjunction with --buckets to print the content of each bucket. |
| --detailed | outputs a detailed output, machine only. |
| --stats-only | outputs system-wide statistics at regular intervals (in seconds) |
| --assembly-manifest | path to the assembly manifest. Adds blob manifest and file path to the detailed json output. Locate manifest in the build output with: cat "assembly_manifests.json" |
| --abridged | use the abridged memory collection that omits Starnix processes. |

#### signal

Signals userspace clients with specified memory pressure level. Clients can use this command to test their response to memory pressure. Does not affect the real memory pressure level on the system, or trigger any kernel reclamation tasks.


    Usage:  ffx profile memory signal level

| **Options** |   |
|---|---|
| --help | display usage information |

### network

Access network activity information


    Usage:  ffx profile network [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [activity](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_network_activity) | Controls the metrics-logger component to log network activity. Logged samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category. |

#### activity

Controls the metrics-logger component to log network activity. Logged samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category.


    Usage:  ffx profile network activity [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_network_activity_start) | Start logging on the target |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_network_activity_stop) | Stop logging on the target |

**Examples**

```
To poll network activity every 500 ms indefinitely:

    $ ffx profile network activity start --interval 500ms

To poll network activity every 1 second for 30 seconds with output-to-syslog enabled:

    $ ffx profile network activity start --interval 1s -d 30s --output-to-syslog
```

**Notes**

-

  ```
  If the metrics-logger component is not available to the target, then this command will not work
  properly. Add --with //src/power/metrics-logger to fx set.
  ```

##### start

Start logging on the target


    Usage:  ffx profile network activity start -s <interval> [--output-to-syslog] [-d <duration>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -s, --interval | interval for polling the network activity |
| --output-to-syslog | toggle for logging samples to syslog |
| -d, --duration | duration for which to log; if omitted, logging will continue indefinitely |

##### stop

Stop logging on the target


    Usage:  ffx profile network activity stop

| **Options** |   |
|---|---|
| --help | display usage information |

### power

Access power-related information


    Usage:  ffx profile power [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [logger](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_power_logger) | Controls the metrics-logger component to log power. Logged power samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category. |

#### logger

Controls the metrics-logger component to log power. Logged power samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category.


    Usage:  ffx profile power logger [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_power_logger_start) | Start logging on the target |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_power_logger_stop) | Stop logging on the target |

**Examples**

```
To poll power sensor every 500 ms indefinitely:

    $ ffx profile power logger start --sampling-interval 500ms

To poll power sensor every 500 ms and summarize statistics every 1 second for 30 seconds with output-samples-to-syslog and output-stats-to-syslog enabled:

    $ ffx profile power logger start --sampling-interval 500ms --statistics-interval 1s --output-stats-to-syslog --output-samples-to-syslog -d 30s
```

**Notes**

-

  ```
  If the metrics-logger component is not available to the target, then this command will not work
  properly. Add --with //src/power/metrics-logger to fx set.
  ```

##### start

Start logging on the target


    Usage:  ffx profile power logger start [-l <statistics-interval>] -s <sampling-interval> [--output-samples-to-syslog] [--output-stats-to-syslog] [-d <duration>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --statistics-interval | interval for summarizing statistics; if omitted, statistics is disabled |
| -s, --sampling-interval | interval for polling the sensor |
| --output-samples-to-syslog | toggle for logging samples to syslog |
| --output-stats-to-syslog | toggle for logging statistics to syslog |
| -d, --duration | duration for which to log; if omitted, logging will continue indefinitely |

##### stop

Stop logging on the target


    Usage:  ffx profile power logger stop

| **Options** |   |
|---|---|
| --help | display usage information |

### stacktrack

Dump stack traces


    Usage:  ffx profile stacktrack [--collector <collector>] [--by-name <by-name>] [--by-koid <by-koid>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --collector | moniker of the collector to be queried (default: autodetect) |
| --by-name | select process by name |
| --by-koid | select process by koid |

### temperature

Access temperature-related information


    Usage:  ffx profile temperature [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [logger](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_temperature_logger) | Controls the metrics-logger component to log temperature. Logged temperature samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category. |

#### logger

Controls the metrics-logger component to log temperature. Logged temperature samples will be available in syslog, via iquery under core/metrics-logger and via tracing in the `metrics_logger` category.


    Usage:  ffx profile temperature logger [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_temperature_logger_start) | Start logging on the target |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profile_temperature_logger_stop) | Stop logging on the target |

**Examples**

```
To poll temperature sensor every 500 ms indefinitely:

    $ ffx profile temperature logger start --sampling-interval 500ms

To poll temperature sensor every 500 ms and summarize statistics every 1 second for 30 seconds with output-samples-to-syslog and output-stats-to-syslog enabled:

    $ ffx profile temperature logger start --sampling-interval 500ms --statistics-interval 1s --output-stats-to-syslog --output-samples-to-syslog -d 30s
```

**Notes**

-

  ```
  If the metrics-logger component is not available to the target, then this command will not work
  properly. Add --with //src/power/metrics-logger to fx set.
  ```

##### start

Start logging on the target


    Usage:  ffx profile temperature logger start [-l <statistics-interval>] -s <sampling-interval> [--output-samples-to-syslog] [--output-stats-to-syslog] [-d <duration>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --statistics-interval | interval for summarizing statistics; if omitted, statistics is disabled |
| -s, --sampling-interval | interval for polling the sensor |
| --output-samples-to-syslog | toggle for logging samples to syslog |
| --output-stats-to-syslog | toggle for logging statistics to syslog |
| -d, --duration | duration for which to log; if omitted, logging will continue indefinitely |

##### stop

Stop logging on the target


    Usage:  ffx profile temperature logger stop

| **Options** |   |
|---|---|
| --help | display usage information |

## profiler

Interact with the profiling subsystem.


    Usage:  ffx profiler [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [attach](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profiler_attach) | Profile a running task or component |
| [download-android-symbols](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profiler_download-android-symbols) | Download Android debug symbols from Android Build using fetch_artifact. |
| [launch](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profiler_launch) | Record a profile. |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profiler_status) | List active profiling sessions. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profiler_stop) | Stop a background profiling session and download results. |
| [symbolize](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_profiler_symbolize) | Symbolize a previously-recorded profile that was not symbolized. |

### attach

Profile a running task or component


    Usage:  ffx profiler attach [--url <url>] [--buffer-size-mb <buffer-size-mb>] [--moniker <moniker>] [--pids <pids...>] [--tids <tids...>] [--job-ids <job-ids...>] [--system-wide] [--duration <duration>] [--output <output>] [--print-stats] [--symbolize <symbolize>] [--pprof-conversion <pprof-conversion>] [--output-format <output-format>] [--sample-period-us <sample-period-us>] [--color-output <color-output>] [--background] [--unwind-strategy <unwind-strategy>] [--on-boot]

| **Options** |   |
|---|---|
| --help | display usage information |
| --url | url of a component to profile. If there is no matching component, wait for one to appear. |
| --buffer-size-mb | buffer size in MiB to profile. Specifies the amount of memory allocated for storing profiling information. |
| --moniker | moniker of a component to profile. If there is no matching component, the profiler will |
| --pids | pids to profile |
| --tids | tids to profile |
| --job-ids | jobs to profile |
| --system-wide | profile everything running on the system. Equivalent to profiling the root job and everything running under it. |
| --duration | how long to profiler for. If unspecified, will interactively wait until is pressed. |
| --output | name of output trace file. Defaults to "profile.pb" ("profile.pftrace" for --output-format perfetto, "profile.fxt" for --output-format fxt). |
| --print-stats | print stats about how the profiling session went |
| --symbolize | if false, output the raw sample file instead of attempting to symbolize it |
| --pprof-conversion | if false, output the raw symbolized sample file instead of attempting to convert to the pprof format. Ignored if --symbolize is false. |
| --output-format | output format for the symbolized profile. "pprof" (default) writes a pprof protobuf; "perfetto" writes a standalone Perfetto trace (.pftrace) with PerfSample packets; "fxt" writes the same packets in FXT BlobType::Perfetto records so it can be concatenated with an `ffx trace` .fxt. For "perfetto" and "fxt" the raw unsymbolized capture is also kept at .raw.fxt so the other container can be produced offline with `ffx profiler symbolize`. Ignored if --symbolize is false. |
| --sample-period-us | how frequently to take a sample |
| --color-output | if true, include color codes in output. Defaults to true if terminal output is detected, else false |
| --background | run the profiler session in the background |
| --unwind-strategy | unwinding strategy to use. Options are "fp" and "dwarf". fp: uses on-device frame pointers for unwinding. dwarf: uses off-device DWARF unwinding. Enable this to profile binaries compiled without frame pointers, such as 32 bit starnix containers. |
| --on-boot | run the profiler session when the device reboots. |

### download-android-symbols

Download Android debug symbols from Android Build using fetch_artifact.


    Usage:  ffx profiler download-android-symbols --bid <bid> --target <target>

| **Options** |   |
|---|---|
| --help | display usage information |
| --bid | build id of the Android target (e.g. 11000000 or P023423) |
| --target | target name of the Android build (e.g. aosp_arm64-userdebug, etc.) |

### launch

Record a profile.


    Usage:  ffx profiler launch --url <url> [--buffer-size-mb <buffer-size-mb>] [--moniker <moniker>] [--duration <duration>] [--output <output>] [--print-stats] [--symbolize <symbolize>] [--pprof-conversion <pprof-conversion>] [--output-format <output-format>] [--sample-period-us <sample-period-us>] [--test] [--test-filters <test-filters...>] [--color-output <color-output>] [--background] [--unwind-strategy <unwind-strategy>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --url | url of a component to launch and profile |
| --buffer-size-mb | buffer size in MiB to profile. Specifies the amount of memory allocated for storing profiling information. |
| --moniker | moniker of a component to attach to and profile. If specified in combination with `--url`, will attempt to launch the component at the given moniker. |
| --duration | how long in seconds to profile for. If unspecified, will interactively wait until is pressed. |
| --output | name of output trace file. Defaults to "profile.pb" ("profile.pftrace" for --output-format perfetto, "profile.fxt" for --output-format fxt). |
| --print-stats | print stats about how the profiling session went |
| --symbolize | if false, output the raw sample file instead of attempting to symbolize it |
| --pprof-conversion | if false, output the raw symbolized sample file instead of attempting to convert to the pprof format. Ignored if --symbolize is false. |
| --output-format | output format for the symbolized profile. "pprof" (default) writes a pprof protobuf; "perfetto" writes a standalone Perfetto trace (.pftrace) with PerfSample packets; "fxt" writes the same packets in FXT BlobType::Perfetto records so it can be concatenated with an `ffx trace` .fxt. For "perfetto" and "fxt" the raw unsymbolized capture is also kept at .raw.fxt so the other container can be produced offline with `ffx profiler symbolize`. Ignored if --symbolize is false. |
| --sample-period-us | how frequently to take a sample. This is the time interval between samples, in microseconds. The default is 10,000 microseconds (10 ms). |
| --test | the package being launched is a test to be launched via test_manager |
| --test-filters | test case filters to apply to profiled tests |
| --color-output | if true, include color codes in output. Defaults to true if terminal output is detected, else false |
| --background | run the profiler session in the background |
| --unwind-strategy | unwinding strategy to use. Options are "fp" and "dwarf". fp: uses on-device frame pointers for unwinding. dwarf: uses off-device DWARF unwinding. Enable this to profile binaries compiled without frame pointers, such as 32 bit starnix containers. |

### status

List active profiling sessions.


    Usage:  ffx profiler status

| **Options** |   |
|---|---|
| --help | display usage information |

### stop

Stop a background profiling session and download results.


    Usage:  ffx profiler stop [--output <output>] [--abort] [--symbolize <symbolize>] [--pprof-conversion <pprof-conversion>] [--output-format <output-format>] [--color-output <color-output>] [--print-stats]

| **Options** |   |
|---|---|
| --help | display usage information |
| --output | path to save the profile |
| --abort | abort the session without saving the profile data |
| --symbolize | whether to try to symbolize the profile using the debug symbol index |
| --pprof-conversion | if false, output the raw symbolized sample file instead of attempting to convert to the pprof format. Ignored if --symbolize is false. |
| --output-format | output format for the symbolized profile. "pprof" (default) writes a pprof protobuf; "perfetto" writes a standalone Perfetto trace (.pftrace) with PerfSample packets; "fxt" writes the same packets in FXT BlobType::Perfetto records so it can be concatenated with an `ffx trace` .fxt. For "perfetto" and "fxt" the raw unsymbolized capture is also kept at .raw.fxt so the other container can be produced offline with `ffx profiler symbolize`. Ignored if --symbolize is false. |
| --color-output | if true, include color codes in output. Defaults to true if terminal output is detected, else false |
| --print-stats | print stats to stdout |

### symbolize

Symbolize a previously-recorded profile that was not symbolized.


    Usage:  ffx profiler symbolize [--pprof-conversion <pprof-conversion>] [--output-format <output-format>] input output

| **Options** |   |
|---|---|
| --help | display usage information |
| --pprof-conversion | if false, output the raw symbolized sample file instead of attempting to convert to the pprof format. |
| --output-format | output format for the symbolized profile. "pprof" (default) writes a pprof protobuf; "perfetto" writes a standalone Perfetto trace (.pftrace) with PerfSample packets; "fxt" writes the same packets in FXT BlobType::Perfetto records so it can be concatenated with an `ffx trace` .fxt. |

## repository

Inspect and manage package repositories


    Usage:  ffx repository [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [create](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_create) | Create a repository. |
| [default](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_default) | Manage the default repository |
| [package](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_package) | List the packages inside a repository |
| [publish](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_publish) | Publish packages. |
| [serve-archive](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_serve-archive) | Serve a package archive to a target device |
| [server](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_server) | Inspect and manage the repository server |

### create

Create a repository.


    Usage:  ffx repository create [--time-versioning] [--keys <keys>] repo_path

| **Options** |   |
|---|---|
| --help | display usage information |
| --time-versioning | set repository version based on the current time rather than monotonically increasing version |
| --keys | path to the repository keys directory. Default to generate keys at 'repo_path'/keys. |

### default

Manage the default repository


    Usage:  ffx repository default [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_default_get) | Get the default configured repository |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_default_set) | Set the default repository |
| [unset](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_default_unset) | Clears the default configured repository |

**Examples**

```
For one-off overrides for the default use `--repository` option:

    $ ffx repository  --repository  ...

Or use the `--config` option:

    $ ffx --config repository.default= repository 
```

**Notes**

-

      Manages the default configured repository for all operations. The default
      repository is designated by a * next to the name. This is an alias for the
      repository.default configuration key.

#### get

Get the default configured repository


    Usage:  ffx repository default get

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  Returns the default configured repository from the 'User Configuration'.
  Returns an empty string if no default is configured.
  ```

#### set

Set the default repository


    Usage:  ffx repository default set [-l <level>] [-b <build-dir>] name

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --level | config level, such as 'user', 'build', or 'global' |
| -b, --build-dir | optional directory to associate the provided build config |

**Examples**

```
To set the default repository:

   $ ffx repository default set 

To set the 'repository.default` key at the global configuration:

   $ ffx repository default set -l global 

To specify a default repository for a specific build directory:

   $ ffx repository default set -l build -b ~/fuchsia/out 
```

**Notes**

-

      Sets the repository.default configuration key. By default sets the key in
      the 'User Configuration'. Can be used in conjuction with ffx repository list
      to list the names of the discovered repositorys.

After setting the default repository, `ffx repository list` will mark the default
with a `*` in the output list.

#### unset

Clears the default configured repository


    Usage:  ffx repository default unset [-l <level>] [-b <build-dir>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --level | config level, such as 'user', 'build', or 'global' |
| -b, --build-dir | optional directory to associate the provided build config |

**Examples**

```
To clear the default repository:

    $ ffx repository default unset

To clear the `repository.default` key from global configuration:

    $ ffx repository default unset -l global

To specify a specific build directory:

    $ ffx repository default unset -l build -b ~/fuchsia/out
```

**Notes**

-

      Clears the repository.default configuration key. By default clears the
      'User Configuration'. Returns a warning if the key is already empty.

### package

List the packages inside a repository


    Usage:  ffx repository package [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [extract-archive](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_package_extract-archive) | Extract a package archive from the repository |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_package_list) | Inspect and manage package repositories |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_package_show) | Inspect content of a package |

#### extract-archive

Extract a package archive from the repository


    Usage:  ffx repository package extract-archive -o <out> [-r <repository>] [-p <port>] [--repo-path <repo-path>] package

| **Options** |   |
|---|---|
| --help | display usage information |
| -o, --out | output path for the extracted archive. |
| -r, --repository | extract package from this repository. |
| -p, --port | repository server port number. Required disambiguate multiple repositories with the same name. |
| --repo-path | list packages stored in the repository stored on disk. |

#### list

Inspect and manage package repositories


    Usage:  ffx repository package list [-r <repository>] [-p <port>] [--repo-path <repo-path>] [--full-hash] [--include-components <include-components>] [--include-size <include-size>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --repository | list packages from a running repository with this name. |
| -p, --port | repository server port number. Required needed to disambiguate multiple repositories with the same name. |
| --repo-path | list packages stored in the repository stored on disk. |
| --full-hash | if true, package hashes will be displayed in full (i.e. not truncated). |
| --include-components | toggle whether components in each package will be fetched and shown in the output table |
| --include-size | toggle whether the sum of the uncompressed size of all blobs in each package will be calculated and shown in the output table |

#### show

Inspect content of a package


    Usage:  ffx repository package show [-r <repository>] [-p <port>] [--repo-path <repo-path>] [--full-hash] [--include-subpackages <include-subpackages>] package

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --repository | list package contents from this repository. |
| -p, --port | repository server port number. Required to disambiguate multiple repositories with the same name. |
| --repo-path | list packages stored in the repository stored on disk. |
| --full-hash | if true, package hashes will be displayed in full (i.e. not truncated). |
| --include-subpackages | if true, show contents of subpackages contained in the package. |

### publish

Publish packages.


    Usage:  ffx repository publish [--signing-keys <signing-keys>] [--trusted-keys <trusted-keys>] [--trusted-root <trusted-root>] [--package <package...>] [--package-list <package-list...>] [--package-archive <package-archive...>] [--product-bundle <product-bundle...>] [--time-versioning] [--metadata-current-time <metadata-current-time>] [--refresh-root] [--clean] [--depfile <depfile>] [--copy-mode <copy-mode>] [--delivery-blob-type <delivery-blob-type>] [--watch] [--ignore-missing-packages] [--blob-manifest <blob-manifest>] [--blob-repo-dir <blob-repo-dir>] repo_path

| **Options** |   |
|---|---|
| --help | display usage information |
| --signing-keys | path to the keys used to sign metadata, but not trust for key rotation |
| --trusted-keys | path to the keys used to sign and trust metadata (default repository `keys/` directory) |
| --trusted-root | path to the initial trusted root metadata (default is to use 1.root.json from the repository) |
| --package | path to a package manifest |
| --package-list | path to a packages list manifest |
| --package-archive | path to a package archive |
| --product-bundle | path to a product bundle |
| --time-versioning | set repository version based on time rather than monotonically increasing version |
| --metadata-current-time | the RFC 3339 time used to see if metadata has expired, and when new metadata should expire (default uses the current time) |
| --refresh-root | generate a new root metadata along side all the other metadata |
| --clean | clean the repository so only new publications remain |
| --depfile | produce a depfile file |
| --copy-mode | mode used to copy blobs to repository. Either 'copy', 'copy-overwrite', or 'hard-link' (default 'copy'). |
| --delivery-blob-type | the type of delivery blob to generate (default: type 1) |
| --watch | republish packages on file change |
| --ignore-missing-packages | ignore if package paths do not exist |
| --blob-manifest | path to write the blob manifest to |
| --blob-repo-dir | path to the blobs directory (default '$repo_path/repository/blobs') |

### serve-archive

Serve a package archive to a target device


    Usage:  ffx repository serve-archive [-r <repository>] [--address <address>] [--alias <alias...>] [--tunnel-addr <tunnel-addr>] [--no-device] archive

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --repository | repository name. Default is `devhost`. |
| --address | address on which to serve the repository. Default is `\[::]:8083`. |
| --alias | set up a rewrite rule mapping each `alias` host to the repository identified by `name`. |
| --tunnel-addr | the address used to listen on target-side when tunneling is used. |
| --no-device | if true, will not register repositories to device. Default is `false`. |

### server

Inspect and manage the repository server


    Usage:  ffx repository server [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_server_list) | Retrieves the status of the running repository servers, including their socket addresses. |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_server_start) | Starts the package repository server. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_repository_server_stop) | Stops the repository server |

#### list

Retrieves the status of the running repository servers, including their socket addresses.


    Usage:  ffx repository server list [--full] [--name <name...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --full | long version of output. |
| --name | limit output to provided name. This option can appear multiple times |

#### start

Starts the package repository server.


    Usage:  ffx repository server start [--address <address>] [--background] [--foreground] [-r <repository>] [--trusted-root <trusted-root>] [--repo-path <repo-path>] [--product-bundle <product-bundle>] [--alias <alias...>] [--storage-type <storage-type>] [--alias-conflict-mode <alias-conflict-mode>] [--port-path <port-path>] [--tunnel-addr <tunnel-addr>] [--no-device] [--refresh-metadata] [--auto-publish <auto-publish>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --address | address on which to serve the repository. Note that this can be either IPV4 or IPV6. For example, \[::\]:8083 or 127.0.0.1:8083 Default is `\[::]:8083`. |
| --background | run server as a background process. This is mutually exclusive with --foreground. |
| --foreground | run server as a foreground process. This is the default mode. This is mutually exclusive with --background. |
| -r, --repository | register this repository. Default is `devhost`. |
| --trusted-root | path to the root metadata that was used to sign the repository TUF metadata. This establishes the root of trust for this repository. If the TUF metadata was not signed by this root metadata, running this command will result in an error. Default is to use 1.root.json from the repository. |
| --repo-path | location of the package repo. Default is given by the build directory obtained from the ffx context. |
| --product-bundle | location of product bundle. |
| --alias | set up a rewrite rule mapping each `alias` host to the repository identified by `name`. |
| --storage-type | enable persisting this repository across reboots. Default is `Ephemeral`. |
| --alias-conflict-mode | resolution mechanism when alias registrations conflict. Must be either `error-out` or `replace`. Default is `replace`. |
| --port-path | location to write server port information to, in case port dynamically instantiated. |
| --tunnel-addr | the address used to listen on target-side when tunneling is used. |
| --no-device | if true, will not register repositories to device. Default is `false`. |
| --refresh-metadata | refresh repository metadata during startup. Note that this is not necessary if package-tool runs in the background taking care of it, e.g. as part of `fx serve`. Default is `false`. |
| --auto-publish | auto publish packages listed in the given manifest. This uses time based versioning when publishing and ignores missing packages. The manifest is a json file a single member "content", which contains a list named "manifest". The list is a list of package manifests, relative paths are relative to the directory of the auto-publish manifest. |

#### stop

Stops the repository server


    Usage:  ffx repository server stop [--all] [--product-bundle <product-bundle>] [-p <port>] [name]

| **Options** |   |
|---|---|
| --help | display usage information |
| --all | stop all repository servers. |
| --product-bundle | stop servers serving the product bundle location. |
| -p, --port | repository server port number. Required to disambiguate multiple repositories with the same name. |

## scrutiny

Audit the security of Fuchsia


    Usage:  ffx scrutiny [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [extract](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_extract) | Extracts common Fuchsia file types |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_list) | Lists properties about build artifacts |
| [shell](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_shell) | Launch the scrutiny shell |
| [verify](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify) | Verify the build |

### extract

Extracts common Fuchsia file types


    Usage:  ffx scrutiny extract [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [blobfs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_extract_blobfs) | Extracts a Blobfs block file |
| [fvm](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_extract_fvm) | Extracts a FVM file |
| [package](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_extract_package) | Extracts a Fuchsia package from a Url |
| [structured-config](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_extract_structured-config) | Extracts the structured configuration from Fuchsia build artifacts. |
| [zbi](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_extract_zbi) | Extracts the Zircon Boot Image |

#### blobfs

Extracts a Blobfs block file


    Usage:  ffx scrutiny extract blobfs input output

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To extract a Blobfs block file:

        $ffx scrutiny extract blobfs blob.blk /tmp/blobs
```

**Notes**

-

  ```
  Extracts a blobfs block file to a specific directory.
  ```

#### fvm

Extracts a FVM file


    Usage:  ffx scrutiny extract fvm input output

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To extract a FVM file:

        $ffx scrutiny extract fvm fvm.blk /tmp/fvm
```

**Notes**

-

  ```
  Extracts a FVM to a specific directory.
  ```

#### package

Extracts a Fuchsia package from a Url


    Usage:  ffx scrutiny extract package --product-bundle <product-bundle> --url <url> --output <output> [--recovery]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | a path to a product bundle that contains the package. |
| --url | the package url. |
| --output | the location to write the output artifacts. |
| --recovery | build scrutiny model based on recovery-mode build artifacts. |

**Examples**

```
To extract a Fuchsia package from a url:

        $ ffx scrutiny extract package --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle --url fuchsia-pkg://fuchsia.com/foo --output /tmp/foo
```

**Notes**

-

  ```
  Extracts a package to a specific directory.
  ```

#### structured-config

Extracts the structured configuration from Fuchsia build artifacts.


    Usage:  ffx scrutiny extract structured-config --product-bundle <product-bundle> --build-path <build-path> --depfile <depfile> --output <output> [--recovery] [--component-tree-config <component-tree-config...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | path to a product bundle. |
| --build-path | path to the build directory which is used to rebase the paths in the depfile. |
| --depfile | path to a depfile that should be written for build integration |
| --output | path to file to which to write the extracted configuration. |
| --recovery | build scrutiny model based on recovery-mode build artifacts. |
| --component-tree-config | absolute or working path-relative path to component tree configuration file that affects how component tree data is gathered. |

**Notes**

-

  ```
  Extracts structured configuration
  ```

#### zbi

Extracts the Zircon Boot Image


    Usage:  ffx scrutiny extract zbi input output

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To extract a Zircon Boot Image:

        $ffx scrutiny extract zbi foo.zbi /tmp/foo
```

**Notes**

-

  ```
  Extracts a ZBI to a specific directory.
  ```

### list

Lists properties about build artifacts


    Usage:  ffx scrutiny list [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [components](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_list_components) | Lists all the components in the build |
| [package](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_list_package) | Lists all the files in a package |
| [packages](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_list_packages) | Lists all the packages in the build |

#### components

Lists all the components in the build


    Usage:  ffx scrutiny list components --product-bundle <product-bundle> [--recovery]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | path to a product bundle. |
| --recovery | build scrutiny model based on recovery-mode build artifacts. |

**Examples**

```
To list all the components in the build:

        $ffx scrutiny list components --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle
```

**Notes**

-

  ```
  Lists all the components in the build in a json format.
  ```

#### package

Lists all the files in a package


    Usage:  ffx scrutiny list package --product-bundle <product-bundle> --url <url> [--recovery]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | path to a product bundle. |
| --url | fuchsia url to the package. |
| --recovery | build scrutiny model based on recovery-mode build artifacts. |

**Examples**

```
To list all the files in a package:

        $ ffx scrutiny list package --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle --url fuchsia-pkg://fuchsia.com/foo
```

**Notes**

-

  ```
  Lists all the package contents in json format.
  ```

#### packages

Lists all the packages in the build


    Usage:  ffx scrutiny list packages --product-bundle <product-bundle> [--recovery]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | path to a product bundle. |
| --recovery | build scrutiny model based on recovery-mode build artifacts. |

**Examples**

```
To list all the packages in the build:

        $ffx scrutiny list packages --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle
```

**Notes**

-

  ```
  Lists all the packages in the build in a json format.
  ```

### shell

Launch the scrutiny shell


    Usage:  ffx scrutiny shell command

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To run commands directly:

    $ ffx scrutiny shell "tool.blobfs.extract --input  --output "
    
```

**Notes**

-

  ```
  Runs a command in scrutiny. Deprecated for the more specific scrutiny methods.
  ```

### verify

Verify the build


    Usage:  ffx scrutiny verify [--depfile <depfile>] [--stamp <stamp>] [--tmp-dir <tmp-dir>] [--recovery] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --depfile | path to depfile that gathers dependencies during execution. |
| --stamp | path to stamp file to write to if and only if verification succeeds. |
| --tmp-dir | path to directory to use for temporary files. |
| --recovery | build scrutiny model based on recovery-mode build artifacts. |

| **Subcommands** |   |
|---|---|
| [bootfs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_bootfs) | Verifies list of files in bootfs inside a product bundle against a golden file |
| [component-resolvers](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_component-resolvers) | Verifies that component configured to use custom component resolvers are permitted by an allowlist. |
| [kernel-cmdline](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_kernel-cmdline) | Verifies that kernel cmdline arguments match golden files. |
| [ota](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_ota) | Runs OTA verification checks. Starting from a given update package hash, this fetches blobs from a delivery blob repository over HTTP. It follows the packages.json and packages' metadata to verify the presence and integrity of the full set of blobs that constitutes an update. |
| [pre-signing](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_pre-signing) | Runs assorted checks to ensure a build is okay to sign |
| [route-sources](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_route-sources) | Verifies that routes to designated components are routed from designated sources. |
| [routes](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_routes) | Verifies capability routes in the component tree |
| [static-pkgs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_static-pkgs) | Check the static packages extracted from the ZBI against golden files |
| [structured-config](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_scrutiny_verify_structured-config) | Verifies component configuration according to configured assertions. |

#### bootfs

Verifies list of files in bootfs inside a product bundle against a golden file


    Usage:  ffx scrutiny verify bootfs --product-bundle <product-bundle> [--golden <golden...>] [--golden-packages <golden-packages...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | absolute or working directory-relative path to a product bundle. |
| --golden | absolute or working directory-relative path(s) to golden file(s) for verifying bootfs paths. |
| --golden-packages | absolute or working directory-relative path(s) to golden file(s) for verifying bootfs packages. |

**Examples**

```
To verify bootfs on your current build:

    $ ffx scrutiny verify bootfs \
        --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle \
        --golden /path/to/goldens/product.txt \
        --golden /path/to/goldens/board.txt
```

**Notes**

-

  ```
  Verifies all file paths in bootfs.
  ```

#### component-resolvers

Verifies that component configured to use custom component resolvers are permitted by an allowlist.


    Usage:  ffx scrutiny verify component-resolvers --product-bundle <product-bundle> --allowlist <allowlist>

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | absolute or working directory-relative path to a product bundle. |
| --allowlist | absolute or working directory-relative path to allowlist file that specifies which components may use particular custom component resolvers. |

**Examples**

```
To verify component resolvers on your current eng build:

    $ ffx scrutiny verify component-resolvers --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle --allowlist ../../src/security/policy/component_resolvers_policy.json5
```

**Notes**

-

  ```
  Verifies all components that use a custom component resolver.
  ```

#### kernel-cmdline

Verifies that kernel cmdline arguments match golden files.


    Usage:  ffx scrutiny verify kernel-cmdline --product-bundle <product-bundle> [--golden <golden...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | absolute or working directory-relative path to a product bundle. |
| --golden | absolute or working directory-relative path(s) to golden files to compare against during verification. |

**Examples**

```
To verify kernel cmdline arguments on your current build:

    $ ffx scrutiny verify kernel-cmdline \
        --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle \
        --golden path/to/golden
```

#### ota

Runs OTA verification checks. Starting from a given update package hash, this fetches blobs from a delivery blob repository over HTTP. It follows the packages.json and packages' metadata to verify the presence and integrity of the full set of blobs that constitutes an update.


    Usage:  ffx scrutiny verify ota --update-package <update-package> --blob-server-url <blob-server-url> [--delivery-blob-type <delivery-blob-type>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --update-package | the merkle hash of the update package |
| --blob-server-url | url of the blob server to fetch artifacts from |
| --delivery-blob-type | optional delivery blob type to use (e.g. 1) |

**Examples**

```
To run the OTA verification checks against a build:

    $ ffx scrutiny verify ota \
        --update-package  \
        --blob-server-url 
```

#### pre-signing

Runs assorted checks to ensure a build is okay to sign


    Usage:  ffx scrutiny verify pre-signing --policy <policy> --product-bundle <product-bundle> --golden-files-dir <golden-files-dir>

| **Options** |   |
|---|---|
| --help | display usage information |
| --policy | path to a signing validation policy file |
| --product-bundle | path to the product bundle for the build to validate |
| --golden-files-dir | path to the directory containing golden files for pre_signing |

**Examples**

```
To run the pre signing checks against a build:

    $ ffx scrutiny verify pre-signing \
        --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle \
        --policy path/to/policy_file \
        --golden_files_dir path/to/goldens/dir
```

#### route-sources

Verifies that routes to designated components are routed from designated sources.


    Usage:  ffx scrutiny verify route-sources --product-bundle <product-bundle> --config <config>

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | absolute or working directory-relative path to a product bundle. |
| --config | absolute or working directory-relative path to configuration file that specifies components and their expected route sources. |

**Examples**

```
To verify route sources according to a configuration file on your current build:

    $ ffx scrutiny verify route-sources
        --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle \
        --config path/to/verify_route_sources/product.board.json5
```

#### routes

Verifies capability routes in the component tree


    Usage:  ffx scrutiny verify routes [--capability-type <capability-type...>] [--response-level <response-level>] --product-bundle <product-bundle> [--component-tree-config <component-tree-config...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --capability-type | capability types to verify. |
| --response-level | response level to report from routes scrutiny plugin. |
| --product-bundle | absolute or working directory-relative path to a product bundle. |
| --component-tree-config | absolute or working path-relative path to component tree configuration file that affects how component tree data is gathered. |

**Examples**

```
To verify routes on your current build:

    $ ffx scrutiny verify routes \
        --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle
```

#### static-pkgs

Check the static packages extracted from the ZBI against golden files


    Usage:  ffx scrutiny verify static-pkgs --product-bundle <product-bundle> [--golden <golden...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --product-bundle | path to a product bundle. |
| --golden | path(s) to golden file(s) used to verify routes. |

**Examples**

```
To verify static packages on your current build:

        $ ffx scrutiny verify static-pkgs --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle --golden path/to/golden
```

#### structured-config

Verifies component configuration according to configured assertions.


    Usage:  ffx scrutiny verify structured-config --policy <policy> --product-bundle <product-bundle> [--component-tree-config <component-tree-config...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --policy | absolute or working directory-relative path to a policy file for structured configuration |
| --product-bundle | path to a product bundle. |
| --component-tree-config | absolute or working path-relative path to component tree configuration file that affects how component tree data is gathered. |

**Examples**

```
To verify structured config on your current build:

    $ ffx scrutiny verify structured-config \
        --product-bundle $(fx get-build-dir)/obj/build/images/fuchsia/product_bundle \
        --policy path/to/policy
        --component-tree-config path/to/platform
        --component-tree-config path/to/product
```

## sdk

Modify or query the installed SDKs


    Usage:  ffx sdk [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [populate-path](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_sdk_populate-path) | Populates the given path with symlinks to the `fuchsha-sdk-run` tool to run project-specific sdk tools |
| [run](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_sdk_run) | Run a host tool from the active sdk |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_sdk_set) | Set sdk-related configuration options |
| [version](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_sdk_version) | Retrieve the version of the current SDK |

### populate-path

Populates the given path with symlinks to the `fuchsha-sdk-run` tool to run project-specific sdk tools


    Usage:  ffx sdk populate-path path

| **Options** |   |
|---|---|
| --help | display usage information |

### run

Run a host tool from the active sdk


    Usage:  ffx sdk run name args

| **Options** |   |
|---|---|
| --help | display usage information |

### set

Set sdk-related configuration options


    Usage:  ffx sdk set [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [root](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_sdk_set_root) | Sets the path to the root of the preferred SDK |

#### root

Sets the path to the root of the preferred SDK


    Usage:  ffx sdk set root path

| **Options** |   |
|---|---|
| --help | display usage information |

### version

Retrieve the version of the current SDK


    Usage:  ffx sdk version

| **Options** |   |
|---|---|
| --help | display usage information |

## session

Control the session component.


    Usage:  ffx session [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session_add) | Add an element to the current session. |
| [drop-power-lease](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session_drop-power-lease) | Drop the power lease reserved for the current session component. |
| [launch](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session_launch) | Launch a session component. |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session_remove) | Remove an element from the current session. |
| [restart](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session_restart) | Restart the current session component. |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session_show) | Show information about the current session |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session_start) | Start the default session component. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_session_stop) | Stop the session component. |

**Notes**

-

  ```
  See https://fuchsia.dev/fuchsia-src/glossary#session-component.
  ```

### add

Add an element to the current session.

If the --persist option is used, the package should be in the base or cache
package set as otherwise it might fail to launch after a reboot.


    Usage:  ffx session add [--interactive] [--persist] [--name <name>] url

| **Options** |   |
|---|---|
| --help | display usage information |
| --interactive | pass to keep element alive until command exits |
| --persist | pass to have the element persist over reboots |
| --name | name for the element which defaults to random if not specified |

**Examples**

```
To add the `bouncing_ball.cm` component as an element:

    $ ffx session add fuchsia-pkg://fuchsia.com/bouncing_ball#meta/bouncing_ball.cm
```

### drop-power-lease

Drop the power lease reserved for the current session component.


    Usage:  ffx session drop-power-lease [--allow-missing]

| **Options** |   |
|---|---|
| --help | display usage information |
| --allow-missing | if true, the tool will not return an error if the lease has already been dropped |

**Notes**

-

  ```
  This command is useful for testing system suspension. If the session component has not taken the lease, then the lease will be dropped. If no other components on the system hold a power lease on the execution state, this will suspend the system.
  ```

### launch

Launch a session component.


    Usage:  ffx session launch [--config <config...>] url

| **Options** |   |
|---|---|
| --help | display usage information |
| --config | provide additional configuration capabilities to the component being run. Specified in the format `fully.qualified.Name=VALUE` where `fully.qualified.Name` is the name of the configuration capability, and `VALUE` is a JSON string which can be resolved as the correct type of configuration value. |

**Examples**

```
To launch the `hello-world-session.cm` component as a session:

    $ ffx session launch fuchsia-pkg://fuchsia.com/hello-world-session#meta/hello-world-session.cm
```

### remove

Remove an element from the current session.

Persistent elements will be removed permanently. Any persistent storage used by
elements will *not* be removed.


    Usage:  ffx session remove name

| **Options** |   |
|---|---|
| --help | display usage information |

### restart

Restart the current session component.


    Usage:  ffx session restart

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  Destroys the existing session component, if any, then creates and starts a new component with the same URL. Requires that a session componentwas previously launched.
  ```

### show

Show information about the current session


    Usage:  ffx session show

| **Options** |   |
|---|---|
| --help | display usage information |

### start

Start the default session component.


    Usage:  ffx session start

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

      The default session component is specified by the URL session_urlin session_manager's structured configuration.

### stop

Stop the session component.


    Usage:  ffx session stop

| **Options** |   |
|---|---|
| --help | display usage information |

## setui

Modify and query settings.


    Usage:  ffx setui [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [accessibility](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_accessibility) | watch or set accessibility settings |
| [audio](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_audio) | get or set audio settings |
| [display](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_display) | get or set display settings |
| [do_not_disturb](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_do_not_disturb) | get or set DnD settings |
| [factory_reset](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_factory_reset) | get or set factory reset settings |
| [input](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_input) | get or set input settings |
| [intl](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_intl) | get or set internationalization settings |
| [keyboard](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_keyboard) | get or set keyboard settings |
| [light](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_light) | get or set light settings |
| [night_mode](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_night_mode) | get or set night mode settings |
| [privacy](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_privacy) | get or set privacy settings |
| [setup](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_setup) | get or set setup settings |

### accessibility

watch or set accessibility settings


    Usage:  ffx setui accessibility [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add-caption](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_accessibility_add-caption) | add caption options, the configuration for which sources get closed caption and how they look |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_accessibility_set) | set other accessibility options |
| [watch](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_accessibility_watch) | watch current accessibility settings |

#### add-caption

add caption options, the configuration for which sources get closed caption and how they look


    Usage:  ffx setui accessibility add-caption [-m <for-media>] [-t <for-tts>] [-w <window-color>] [-b <background-color>] [-f <font-family>] [-c <font-color>] [-r <relative-size>] [-e <char-edge-style>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -m, --for-media | enable closed captions for media sources of audio |
| -t, --for-tts | enable closed captions for Text-To-Speech sources of audio |
| -w, --window-color | border color used around the closed captions window. Valid options are red, green, and blue |
| -b, --background-color | border color used around the closed captions window. Valid options are red, green, and blue |
| -f, --font-family | font family for captions as specified by 47 CFR §79.102(k). Valid options are unknown, monospaced_serif, proportional_serif, monospaced_sans_serif, proportional_sans_serif, casual, cursive, and small_capitals |
| -c, --font-color | color of the closed caption text. Valid options are red, green, and blue |
| -r, --relative-size | size of closed captions text relative to the default captions size, specified in the range \[0.5, 2\] as per 47 CFR §79.103(c)(4) |
| -e, --char-edge-style | edge style for fonts as specified in 47 CFR §79.103(c)(7). Valid options are none, drop_shadow, raised, depressed, outline |

#### set

set other accessibility options


    Usage:  ffx setui accessibility set [-a <audio-description>] [-s <screen-reader>] [-i <color-inversion>] [-m <enable-magnification>] [-c <color-correction>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -a, --audio-description | when set to 'true', will turn on an audio track for videos that includes a description of what is occurring in the video |
| -s, --screen-reader | when set to 'true', will read aloud elements of the screen selected by the user |
| -i, --color-inversion | when set to 'true', will invert the colors on the screen |
| -m, --enable-magnification | when set to 'true', will interpret triple-taps on the touchscreen as a command to zoom in |
| -c, --color-correction | configures the type of color-blindness to correct for. Valid options are none, protanomaly, deuteranomaly, and tritanomaly |

#### watch

watch current accessibility settings


    Usage:  ffx setui accessibility watch

| **Options** |   |
|---|---|
| --help | display usage information |

### audio

get or set audio settings


    Usage:  ffx setui audio [-t <stream>] [-s <source>] [-l <level>] [-v <volume-muted>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -t, --stream | which stream should be modified. Valid options are background, media, interruption, system_agent, communication and accessibility. |
| -s, --source | which source is changing the stream. Valid options are user, system, and system_with_feedback |
| -l, --level | the volume level specified as a float in the range \[0, 1\] |
| -v, --volume-muted | whether or not the volume is muted |

### display

get or set display settings


    Usage:  ffx setui display [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_display_get) | Get the current display settings. |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_display_set) | Sets display settings. |
| [watch](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_setui_display_watch) | Get the current display settings and watch for changes. |

#### get

Get the current display settings.


    Usage:  ffx setui display get [-f <field>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -f, --field | choose which display settings field value to return, valid options are auto and brightness |

#### set

Sets display settings.


    Usage:  ffx setui display set [-b <brightness>] [-o <auto-brightness-level>] [-a <auto-brightness>] [-m <low-light-mode>] [-t <theme>] [-s <screen-enabled>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -b, --brightness | the brightness value specified as a float in the range \[0, 1\] |
| -o, --auto-brightness-level | the brightness values used to control auto brightness as a float in the range \[0, 1\] |
| -a, --auto-brightness | when set to 'true', enables auto brightness |
| -m, --low-light-mode | which low light mode setting to enable. Valid options are enable, disable, and disable_immediately |
| -t, --theme | which theme to set for the device. Valid options are default, dark, light, darkauto, and lightauto |
| -s, --screen-enabled | when set to 'true' the screen is enabled |

#### watch

Get the current display settings and watch for changes.


    Usage:  ffx setui display watch

| **Options** |   |
|---|---|
| --help | display usage information |

### do_not_disturb

get or set DnD settings


    Usage:  ffx setui do_not_disturb [-u <user-dnd>] [-n <night-mode-dnd>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -u, --user-dnd | when set to 'true', allows the device to enter do not disturb mode |
| -n, --night-mode-dnd | when set to 'true', forces the device into do not disturb mode |

### factory_reset

get or set factory reset settings


    Usage:  ffx setui factory_reset [-l <is-local-reset-allowed>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --is-local-reset-allowed | when set to 'true', factory reset can be performed on the device |

### input

get or set input settings


    Usage:  ffx setui input [-t <device-type>] [-n <name>] [-s <state>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -t, --device-type | the type of input device. Valid options are camera and microphone |
| -n, --name | the name of the device. Must be unique within a device type |
| -s, --state | the device state flags, pass a comma separated string of the values available, active, muted, disabled and error. E.g. "-s available,active" |

### intl

get or set internationalization settings


    Usage:  ffx setui intl [-z <time-zone>] [-u <temperature-unit>] [-l <locales...>] [-h <hour-cycle>] [--clear-locales]

| **Options** |   |
|---|---|
| --help | display usage information |
| -z, --time-zone | a valid timezone matching the data available at https://www.iana.org/time-zones |
| -u, --temperature-unit | the unit to use for temperature. Valid options are celsius and fahrenheit |
| -l, --locales | list of locales, separated by spaces, formatted by Unicode BCP-47 Locale Identifier, e.g. en-us |
| -h, --hour-cycle | the hour cycle to use. Valid options are h11 for 12-hour clock with 0:10 am after midnight, h12 for 12-hour clock with 12:10am after midnight, h23 for 24-hour clock with 0:10 after midnight, and h24 for 24-hour clock with 24:10 after midnight |
| --clear-locales | if set, this flag will set locales as an empty list. Overrides the locales arguments |

### keyboard

get or set keyboard settings


    Usage:  ffx setui keyboard [-k <keymap>] [-d <autorepeat-delay>] [-p <autorepeat-period>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -k, --keymap | keymap selection for the keyboard. Valid options are - UsQwerty - FrAzerty - UsDvorak - UsColemak |
| -d, --autorepeat-delay | delay value of autorepeat values for the keyboard. Values should be a positive integer plus an SI time unit. Valid units are s, ms. If this value and autorepeat_period are zero, the autorepeat field of KeyboardSettings will be cleaned as None. |
| -p, --autorepeat-period | period value of autorepeat values for the keyboard. Values should be a positive integer plus an SI time unit. Valid units are s, ms. If this value and autorepeat_delay are zero, the autorepeat field of KeyboardSettings will be cleaned as None. |

### light

get or set light settings


    Usage:  ffx setui light [-n <name>] [-s <simple...>] [-b <brightness...>] [-r <rgb...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -n, --name | name of a light group to set values for. Required if setting the value of a light group |
| -s, --simple | repeated parameter for a list of simple on/off values to set for a light group. |
| -b, --brightness | repeated parameter for a list of floating point brightness values in the range \[0, 1\] for a light group |
| -r, --rgb | repeated parameter for a list of RGB values to set for a light group. Values should be in the range \[0, 1\] and specified as a comma-separated list of the red, green, and blue components. Ex. 0.1,0.4,0.23 |

### night_mode

get or set night mode settings


    Usage:  ffx setui night_mode [-n <night-mode-enabled>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -n, --night-mode-enabled | when 'true', enables night mode |

### privacy

get or set privacy settings


    Usage:  ffx setui privacy [-u <user-data-sharing-consent>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -u, --user-data-sharing-consent | when 'true', is considered to be user giving consent to have their data shared with product owner, e.g. for metrics collection and crash reporting |

### setup

get or set setup settings


    Usage:  ffx setui setup [-i <interfaces>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -i, --interfaces | a supported group of interfaces, specified as a comma-delimited string of the valid values eth and wifi, e.g. "-i eth,wifi" or "-i wifi" |

## speedtest

Test ffx latency and throughput between the host and target.


    Usage:  ffx speedtest [--overnet] [-r <repeat>] [-I <delay>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --overnet | test the legacy Overnet connectivity. |
| -r, --repeat | how many times to repeat the test. Set zero to run until interrupted. |
| -I, --delay | time to delay between repetitions, in milliseconds. |

| **Subcommands** |   |
|---|---|
| [ping](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_speedtest_ping) | Calculates latency to the target with simple channel messages. |
| [socket](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_speedtest_socket) | Calculates throughput to the target using zircon socket abstractions. |

### ping

Calculates latency to the target with simple channel messages.


    Usage:  ffx speedtest ping [-c <count>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -c, --count | the number of probes to send to calculate average latency. |

### socket

Calculates throughput to the target using zircon socket abstractions.


    Usage:  ffx speedtest socket [-L <transfer-mb>] [-b <buffer-kb>] [-R] [--fdomain-individual-reads] [--fdomain-writes-in-flight <fdomain-writes-in-flight>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -L, --transfer-mb | transfer size in Mega Bytes (MB). |
| -b, --buffer-kb | buffer size in Kilo Bytes (KiB). |
| -R, --rx | perform target-\>host transfer. host-\>target transfer is performed by default. |
| --fdomain-individual-reads | suppress the use of FDomain's streaming read API and instead receive data by making individual read requests. This means more round trips and less efficient use of the stream. |
| --fdomain-writes-in-flight | how many writes to send via FDomain at a time before waiting for a response. More writes in flight means better chance of saturating the outgoing stream. Defaults to enough to send the whole transfer at once. |

## starnix

Control starnix containers


    Usage:  ffx starnix [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [adb](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_starnix_adb) | Bridge from host adb to adbd running inside starnix |
| [console](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_starnix_console) | Attach a console to a starnix container |
| [kill](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_starnix_kill) | Sends to the task with , inside the container |
| [vmo](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_starnix_vmo) | Return all processes that have references to a file backed by a vmo with koid |

### adb

Bridge from host adb to adbd running inside starnix


    Usage:  ffx starnix adb [--adb <adb>] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --adb | path to the adb client command |

| **Subcommands** |   |
|---|---|
| [connect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_starnix_adb_connect) | directly connect the local adb server to an adbd instance running on the target. |
| [proxy](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_starnix_adb_proxy) | Bridge from host adb to adbd running inside starnix |

**Examples**

```
ffx starnix adb proxy
```

#### connect

directly connect the local adb server to an adbd instance running on the target.


    Usage:  ffx starnix adb connect

| **Options** |   |
|---|---|
| --help | display usage information |

#### proxy

Bridge from host adb to adbd running inside starnix


    Usage:  ffx starnix adb proxy [-m <moniker>] [-p <port>] [--no-autoconnect]

| **Options** |   |
|---|---|
| --help | display usage information |
| -m, --moniker | the moniker of the container running adbd (defaults to looking for a container in the current session) |
| -p, --port | which port to serve the adb server on |
| --no-autoconnect | disable automatically running "adb connect" |

### console

Attach a console to a starnix container


    Usage:  ffx starnix console [-m <moniker>] [-e <env...>] argv

| **Options** |   |
|---|---|
| --help | display usage information |
| -m, --moniker | the moniker of the container in which to create the console (defaults to looking for a container in the current session) |
| -e, --env | environment variables to pass to the program. |

**Examples**

```
ffx starnix console \[-e ENV=VAL -e ...] program \[argument ...]
```

### kill

Sends to the task with , inside the container


    Usage:  ffx starnix kill -p <pid> -s <signal>

| **Options** |   |
|---|---|
| --help | display usage information |
| -p, --pid | the linux pid to send the signal to |
| -s, --signal | the signal to send |

**Examples**

```
ffx starnix kill  
```

### vmo

Return all processes that have references to a file backed by a vmo with koid


    Usage:  ffx starnix vmo -k <koid>

| **Options** |   |
|---|---|
| --help | display usage information |
| -k, --koid | koid of the vmo to search for references to. |

**Examples**

```
ffx starnix vmo -k 123456
```

## storage

Manage Fuchsia Filesystems.


    Usage:  ffx storage [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [fxfs](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_storage_fxfs) | Interact with fxfs instances. |

### fxfs

Interact with fxfs instances.


    Usage:  ffx storage fxfs [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [compact](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_storage_fxfs_compact) | Forces a (blocking) compaction of all layer files. |
| [delete_profile](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_storage_fxfs_delete_profile) | Deletes a profile from a named unlocked volume. Fails during active profile record and/or replay. |
| [record_and_replay_profile](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_storage_fxfs_record_and_replay_profile) | Starts recording a for a named unlocked volume to run for a limited number of time. If a profile exists on the volume with the given name, then it will also begin replaying it. If no volume is given, then all unlocked volumes are activated for recording and replay. Fails during active profile recording and/or replay. |
| [replay_xor_record_profile](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_storage_fxfs_replay_xor_record_profile) | Replays a profile for a named unlocked volume if one exists, otherwise it starts recording one. The identifier is either a uint node id, or 64 character hex encoding of blob root hash, for the latter specify -b. Fails during active profile recording and/or replay. |
| [stop_profile](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_storage_fxfs_stop_profile) | Blocks while stopping all profile recording and/or replay activity. |

#### compact

Forces a (blocking) compaction of all layer files.


    Usage:  ffx storage fxfs compact

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx storage fxfs compact
```

#### delete_profile

Deletes a profile from a named unlocked volume. Fails during active profile record and/or replay.


    Usage:  ffx storage fxfs delete_profile volume profile

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx storage fxfs delete_profile
```

#### record_and_replay_profile

Starts recording a for a named unlocked volume to run for a limited number of time. If a profile exists on the volume with the given name, then it will also begin replaying it. If no volume is given, then all unlocked volumes are activated for recording and replay. Fails during active profile recording and/or replay.


    Usage:  ffx storage fxfs record_and_replay_profile [-v <volume>] profile duration_secs

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --volume | the volume to affect instead of all unlocked volumes. |

**Examples**

```
ffx storage fxfs record_and_replay_profile --volume data startup 60 
```

#### replay_xor_record_profile

Replays a profile for a named unlocked volume if one exists, otherwise it starts recording one. The identifier is either a uint node id, or 64 character hex encoding of blob root hash, for the latter specify -b. Fails during active profile recording and/or replay.


    Usage:  ffx storage fxfs replay_xor_record_profile -v <volume> [-b] identifier duration_secs

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --volume | the volume to affect. |
| -b, --blob | whether the identifier is a 64-character hex blob hash instead of an object ID. |

**Examples**

```
ffx storage fxfs replay_xor_record_profile --volume data startup 60 
```

#### stop_profile

Blocks while stopping all profile recording and/or replay activity.


    Usage:  ffx storage fxfs stop_profile

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
ffx storage fxfs stop_profile
```

## target

Interact with a target device or emulator


    Usage:  ffx target [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [add](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_add) | Make the daemon aware of a specific target |
| [bootloader](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_bootloader) | Communicates with the bootloader |
| [default](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_default) | View the default target |
| [discover](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_discover) | Discovers targets |
| [echo](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_echo) | run echo test against the target |
| [fastboot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot) | Perform fastboot operations on a target device |
| [flash](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_flash) | Flash an image to a target device |
| [get-time](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_get-time) | Returns the current time in the system monotonic clock. This is the number of nanoseconds since the system was powered on. It does not always reset on reboot and does not adjust during sleep, and thus should not be used as a reliable source of uptime. See https://fuchsia.dev/reference/syscalls/clock_get_monotonic |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_list) | List all targets |
| [log-message](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_log-message) | Writes a message to the device's log. |
| [off](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_off) | Powers off a target |
| [package](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_package) | Interact with target package management |
| [reboot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_reboot) | Reboots a target |
| [remove](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_remove) | Make the daemon forget a specific target |
| [repository](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_repository) | Interact with target repository registration |
| [screenshot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_screenshot) | Takes a screenshot of the target |
| [shell](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_shell) | open a developer shell to a target device |
| [show](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_show) | Display relevant information for the target |
| [snapshot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_snapshot) | Takes a snapshot of the target's state |
| [ssh](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_ssh) | SSH to a target device |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_status) | Run status checks step by step to determine a device's state |
| [update](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update) | Update base system software on target |
| [wait](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_wait) | Wait for a target to reach a specific state. |
| [wipe](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_wipe) | Performs a factory data reset |

**Notes**

-

      The target subcommand contains various commands for target management
      and interaction.

Typically, this is the entry workflow for users, allowing for target
discovery and provisioning before moving on to `component` or `session`
workflows once the system is up and running on the target.

Most of the commands depend on the RCS (Remote Control Service) on the
target.

### add

Make the daemon aware of a specific target


    Usage:  ffx target add [-n] addr

| **Options** |   |
|---|---|
| --help | display usage information |
| -n, --nowait | do not wait for a connection to be verified on the Fuchsia device. |

**Examples**

```
To add a remote target forwarded via ssh:

    $ ffx target add 127.0.0.1:8022

Or to add a target using its IPV6:

    $ ffx target add fe80::32fd:38ff:fea8:a00a
```

**Notes**

-

      Manually add a target based on its IP address. The command accepts IPV4
      or IPV6 addresses, including a port number: <addr> = <ip addr:port>.

Typically, the daemon automatically discovers targets as they come online.
However, manually adding a target allows for specifying a port number or
address, often used for remote workflows.

This command will attempt to connect to the target in order to verify that RCS can
be used, allowing for typical FFX related workflows. If you do not wish to use
this, then you can run use the `--nowait` flag to return immediately. This can be
useful for debugging connection issues.

If you send SIGINT (Ctrl-C) to the command before the connection to the target is
verified, the target will be removed. If RCS cannot be connected to (e.g. some
connectivity error is encountered), the target will also be removed.

### bootloader

Communicates with the bootloader


    Usage:  ffx target bootloader [-m <manifest>] [-p <product>] [-b <product-bundle>] [--skip-verify] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -m, --manifest | path to flashing manifest or zip file containing images and manifest |
| -p, --product | product entry in manifest - defaults to `fuchsia` |
| -b, --product-bundle | optional product bundle name |
| --skip-verify | skip hardware verification. This is dangerous, please be sure the images you are using match the device |

| **Subcommands** |   |
|---|---|
| [boot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_bootloader_boot) | RAM boots a fastboot target. |
| [info](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_bootloader_info) | Prints fastboot variables for target. |
| [lock](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_bootloader_lock) | Locks a fastboot target. |
| [unlock](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_bootloader_unlock) | Unlocks a fastboot target. |

#### boot

RAM boots a fastboot target.


    Usage:  ffx target bootloader boot [-z <zbi>] [-v <vbmeta>] [-s <slot>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -z, --zbi | optional zbi image file path to use |
| -v, --vbmeta | optional vbmeta image file path to use |
| -s, --slot | slot corresponding to partitions in the flash manifest - |

only used if zbi and vbmeta files are not present

#### info

Prints fastboot variables for target.


    Usage:  ffx target bootloader info

| **Options** |   |
|---|---|
| --help | display usage information |

#### lock

Locks a fastboot target.


    Usage:  ffx target bootloader lock

| **Options** |   |
|---|---|
| --help | display usage information |

#### unlock

Unlocks a fastboot target.


    Usage:  ffx target bootloader unlock [-c <cred>] [--force]

| **Options** |   |
|---|---|
| --help | display usage information |
| -c, --cred | optional path to credential file to use to unlock the device |
| --force | skips the warning message that this command is dangerous |

### default

View the default target


    Usage:  ffx target default [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_default_get) | Get the default configured target |

**Examples**

```
For one-off overrides for the default use `--target` option:
    $ ffx --target  

Set the default target in-tree with `fx set-device`:
    $ fx set-device 

Set the default target out-of-tree with the `$FUCHSIA_NODENAME` environment variable:
    $ export FUCHSIA_NODENAME=

Unset the default target in-tree with `fx unset-device`:
    $ fx unset-device

Unset the default target out-of-tree with the `$FUCHSIA_NODENAME` environment variable:
    $ unset FUCHSIA_NODENAME

Verify the correct default target setting with `ffx target default get`:
    $ ffx target default get
```

**Notes**

-

      Views the default configured target used for all operations.
      In ffx target list the default target is designated by a * next to the name.

#### get

Get the default configured target


    Usage:  ffx target default get

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  Returns the effective default configured target from configuration,
  $FUCHSIA_NODENAME, and $FUCHSIA_DEVICE_ADDR.
  Returns an empty string if no default is configured.
  ```

### discover

Discovers targets


    Usage:  ffx target discover [-l <loop>] [-q] [-t <time>] [--stop] [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |
| -l, --loop | run in a loop, in the specified mode (fg or bg) |
| -q, --quiet | do not write to stdout |
| -t, --time | time in seconds between updates (default: 60). 0 to run once (only valid in foreground) |
| --stop | stop the discover process (whether in foreground or background) |

| **Subcommands** |   |
|---|---|
| [clear](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_discover_clear) | clear the discovery cache |

**Notes**

-

  ```
  Discovers targets, storing them in the discovery cache. By default, runs as a background process.
  ```

#### clear

clear the discovery cache


    Usage:  ffx target discover clear

| **Options** |   |
|---|---|
| --help | display usage information |

### echo

run echo test against the target


    Usage:  ffx target echo [--repeat] [text]

| **Options** |   |
|---|---|
| --help | display usage information |
| --repeat | run the echo test repeatedly until the command is killed |

### fastboot

Perform fastboot operations on a target device


    Usage:  ffx target fastboot [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [authorize](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot_authorize) | Authorize subcommand. |
| [continue](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot_continue) | Continue subcommand |
| [flash](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot_flash) | Flash subcommand |
| [getvar](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot_getvar) | Get Variable subcommand |
| [oem](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot_oem) | Oem subcommand |
| [reboot](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot_reboot) | Reboot subcommand |
| [sparse](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot_sparse) | Sparse subcommand. |
| [stage](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_fastboot_stage) | Stage subcommand |

**Examples**

```
To flash a specific image:

    $ ffx target fastboot flash super foo.zbi
```

#### authorize

Authorize subcommand.


    Usage:  ffx target fastboot authorize [-p <product-bundle>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -p, --product-bundle | path to a product bundle to extract SSH key upload method from |

**Notes**

-

  ```
  Sends a Fuchsia-specific OEM command to the target to upload the
  ssh authorized keys and continue boot for the Target.
  ```

#### continue

Continue subcommand


    Usage:  ffx target fastboot continue

| **Options** |   |
|---|---|
| --help | display usage information |

#### flash

Flash subcommand


    Usage:  ffx target fastboot flash [-S <max-download-size>] [--streaming-flash <streaming-flash>] partition file

| **Options** |   |
|---|---|
| --help | display usage information |
| -S, --max-download-size | overriding the maximum download size |
| --streaming-flash | use streaming fastboot flash if supported by the device |

#### getvar

Get Variable subcommand


    Usage:  ffx target fastboot getvar var_name

| **Options** |   |
|---|---|
| --help | display usage information |

#### oem

Oem subcommand


    Usage:  ffx target fastboot oem command

| **Options** |   |
|---|---|
| --help | display usage information |

#### reboot

Reboot subcommand


    Usage:  ffx target fastboot reboot [bootloader]

| **Options** |   |
|---|---|
| --help | display usage information |

#### sparse

Sparse subcommand.


    Usage:  ffx target fastboot sparse [--size <size>] file out_dir

| **Options** |   |
|---|---|
| --help | display usage information |
| --size | size to split the image into. If unset defaults to target's max download size |

**Notes**

-

      Takes the provided file and out_dir and breaks the input file into
      a set of files named in format n-tmp.img, each of which is no larger than
      size (defaulting to Target's max download size) and is in the Android
      Sparse Image Format.

#### stage

Stage subcommand


    Usage:  ffx target fastboot stage file

| **Options** |   |
|---|---|
| --help | display usage information |

### flash

Flash an image to a target device


    Usage:  ffx target flash [-p <product>] [-b <product-bundle>] [-m <manifest>] [--oem-stage <oem-stage...>] [--authorized-keys <authorized-keys>] [--no-bootloader-reboot] [--skip-verify] [--timeout-rate <timeout-rate>] [--min-timeout-secs <min-timeout-secs>] [--streaming-flash <streaming-flash>] [manifest_path]

| **Options** |   |
|---|---|
| --help | display usage information |
| -p, --product | product entry in manifest - defaults to `fuchsia` |
| -b, --product-bundle | optional product bundle name |
| -m, --manifest | optional manifest path |
| --oem-stage | oem staged file - can be supplied multiple times |
| --authorized-keys | path to authorized keys file - will default to the value configured for `ssh.pub` key in ffx config. If the file does not exist, it will be created. |
| --no-bootloader-reboot | the device should not reboot after bootloader images are flashed |
| --skip-verify | skip hardware verification. This is dangerous, please be sure the images you are flashing match the device |
| --timeout-rate | flash timeout rate in mb/second. |
| --min-timeout-secs | minimum timeout in seconds to wait while flashing per-partition |
| --streaming-flash | use streaming fastboot flash if supported by the device |

**Examples**

```
To flash a specific image:

    $ ffx target flash --manifest $(fx get-build-dir)/flash.json --product fuchsia

To include SSH keys as well:

    $ ffx target flash
    --authorized-keys ~/fuchsia/.ssh/authorized_keys
    $(fx get-build-dir)/flash.json
    --product fuchsia
```

**Notes**

-

  ```
  Flashes an image to a target device using the fastboot protocol.
  Requires a specific  file and  name as an input.
  ```

This is only applicable to a physical device and not an emulator target.
The target device is typically connected via a micro-USB connection to
the host system.

The format is a JSON file generated when building a fuchsia and can be found in the build output directory.

The `--oem-stage` option can be supplied multiple times for several OEM
files. The format expects a single OEM command to execute after staging
the given file.

The format for the `--oem-stage` parameter is a comma separated pair:
','

### get-time

Returns the current time in the system monotonic clock. This is the number of nanoseconds since the system was powered on. It does not always reset on reboot and does not adjust during sleep, and thus should not be used as a reliable source of uptime. See https://fuchsia.dev/reference/syscalls/clock_get_monotonic


    Usage:  ffx target get-time [-b]

| **Options** |   |
|---|---|
| --help | display usage information |
| -b, --boot | if true, return boot time |

**Examples**

```
To get the target time:

    $ ffx target get-time
```

### list

List all targets


    Usage:  ffx target list [-f <format>] [--no-ipv4] [--no-ipv6] [--allow-addrs <allow-addrs>] [--deny-addrs <deny-addrs>] [--no-probe] [--no-mdns] [--no-usb] [--register] [nodename]

| **Options** |   |
|---|---|
| --help | display usage information |
| -f, --format | determines the output format for the list operation |
| --no-ipv4 | do not return IPv4 addresses (deprecated, use --allow-addrs/--deny-addrs) |
| --no-ipv6 | do not return IPv6 addresses (deprecated, use --allow-addrs/--deny-addrs) |
| --allow-addrs | list of address types to show in the output. Value is a comma-separated list of address types. Use 'ipv4', 'ip4', or '4' for IPv4 addresses, 'ipv6', 'ip6' or '6' for IPv6 addresses, 'usb' for USB addresses (e.g. "usb:cid:4"), and 'vsock' for VSOCK addresses (e.g. "vsock:cid:4"). You can also use "all" to accept any addresses, which is the default. --allow-addrs applies before --deny-addrs. |
| --deny-addrs | list of address types to show in the output. Value is a comma-separated list of address types. Use 'ipv4', 'ip4', or '4' for IPv4 addresses, 'ipv6', 'ip6' or '6' for IPv6 addresses, 'usb' for USB addresses (e.g. "usb:cid:4"), and 'vsock' for VSOCK addresses (e.g. "vsock:cid:4"). You can also use "none" to accept any addresses, which is the default. --allow-addrs applies before --deny-addrs. |
| --no-probe | do not connect to targets (direct mode only) |
| --no-mdns | do not do mDNS discovery (direct mode only) |
| --no-usb | do not do USB discovery (direct mode only) |
| --register | register discovered targets in $SHARED_DATA/targets.json (strict mode only) |

**Examples**

```
To list targets in short form:

    $ ffx target list --format s
    fe80::4415:3606:fb52:e2bc%zx-f80ff974f283 pecan-guru-clerk-rhyme

To list targets with only their addresses:

    $ ffx target list --format a
    fe80::4415:3606:fb52:e2bc%zx-f80ff974f283
```

**Notes**

-

  ```
  List all targets.
  ```

In daemon mode (default), this lists targets that the daemon currently has in memory. This includes
manually added targets. The daemon also proactively discovers targets as
they come online. Use `ffx target list` to always get the latest list
of targets. Targets are sorted by name.

In direct mode, this lists targets discovered by searching the local network (mDNS) and USB connections.

The default target is marked with a '\*' next to the node name. The table
has the following columns:

    NAME = The name of the target.
    SERIAL = The serial number of the target.
    TYPE = The product type of the target.
    STATE = The high-level state of the target.
    ADDRS/IP = The discovered and known addresses of the target.
    RCS = Indicates if the Remote Control Service is running on the target.

The NAME column shows the target's advertised name. When the target is
in early boot state such as fastboot, the NAME column may be `<unknown>` with
a STATE being `fastboot` and a SERIAL attribute.

By default, the `list` command outputs in a tabular format. To override
the format, pass `--format` and can take the following options: 'simple\|s'
, 'tabular\|table\|tab\|t', 'addresses\|addrs\|addr\|a', 'name-only\|n', 'json\|JSON\|j' or
'serials'.

By default, Zedboot discovery is disabled. To enable discovery of Zedboot
targets run:

    $ ffx config set discovery.zedboot.enabled true

<br />

| **Errors** |   |
|---|---|
| 2 | If a nodename is supplied, an error code of 2 will be returned if the nodename cannot be resolved |

### log-message

Writes a message to the device's log.


    Usage:  ffx target log-message [-t <tag>] [-s <severity>] message

| **Options** |   |
|---|---|
| --help | display usage information |
| -t, --tag | the log tag to use |
| -s, --severity | trace, debug, info, warn, error, fatal |

**Examples**

```
To write a message:

    $ ffx target log-message "this is a log message"
```

### off

Powers off a target


    Usage:  ffx target off

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  Power off a target. Uses the 'fuchsia.hardware.power.statecontrol.Admin'
  FIDL API to send the power off command.
  ```

'fuchsia.hardware.power.statecontrol.Admin' is exposed by the 'power_manager'
component. To verify that the target exposes this service, `ffx component
select` or `ffx component knock` can be used.

| **Errors** |   |
|---|---|
| 1 | Timeout while powering off target. |

### package

Interact with target package management


    Usage:  ffx target package [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [explore](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_package_explore) | Resolves a package and then spawns a shell with said package loaded into the namespace at /pkg. |
| [gc](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_package_gc) | Trigger garbage collection on a target |
| [resolve](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_package_resolve) | Resolve packages from configured repositories on a target |

**Notes**

-

  ```
  The `package` subcommand contains various commands for package management on-target.

  Most of the commands depend on the RCS (Remote Control Service) on the target.
  ```

#### explore

Resolves a package and then spawns a shell with said package loaded into the namespace at /pkg.


    Usage:  ffx target package explore [--subpackage <subpackage...>] [--tools <tools...>] [-c <command>] [--fuchsia-pkg-resolver <fuchsia-pkg-resolver>] url

| **Options** |   |
|---|---|
| --help | display usage information |
| --subpackage | the chain of subpackages, if any, of `url` to resolve, in resolution order. If `subpackages` is not empty, the package directory of the final subpackage will be loaded into the shell's namespace at `/pkg`. |
| --tools | list of URLs of tools packages to include in the shell environment. the PATH variable will be updated to include binaries from these tools packages. repeat `--tools url` for each package to be included. The path preference is given by command line order. |
| -c, --command | execute a command instead of reading from stdin. the exit code of the command will be forwarded to the host. |
| --fuchsia-pkg-resolver | the resolver to use when resolving package URLs with scheme "fuchsia-pkg". Possible values are "base" and "full". Defaults to "full". |

**Examples**

```
To explore the update package interactively:

> ffx target package explore 'fuchsia-pkg://fuchsia.com/update'
$ ls
svc
pkg
$ exit
Connection to terminal closed

To run a command directly from the command line:
> ffx target package explore 'fuchsia-pkg://fuchsia.com/update' -c 'printenv'
PATH=/.dash/tools/debug-dash-launcher
PWD=/
```

**Notes**

-

  ```
  The environment contains the following directories:
  ```
- /.dash User-added and built-in dash tools
- /pkg The package directory of the resolved package
- /svc Protocols required by the dash shell

If additional binaries are provided via --tools, they will be loaded into .dash/tools// The path is set so that they can be run by name. The path preference is in the command line order of the --tools arguments, ending with the built-in dash tools (/.dash/tools/debug-dash-launcher).

--tools URLs may be package or binary URLs. Note that collisions can occur if different URLs have
the same package and binary names. An error, `NonUniqueBinaryName`, is returned if a binary name
collision occurs.

#### gc

Trigger garbage collection on a target


    Usage:  ffx target package gc

| **Options** |   |
|---|---|
| --help | display usage information |

#### resolve

Resolve packages from configured repositories on a target


    Usage:  ffx target package resolve [package]

| **Options** |   |
|---|---|
| --help | display usage information |

### reboot

Reboots a target


    Usage:  ffx target reboot [-b] [-r]

| **Options** |   |
|---|---|
| --help | display usage information |
| -b, --bootloader | reboot to bootloader |
| -r, --recovery | reboot to recovery |

**Notes**

-

  ```
  Reboot a target. Uses the 'fuchsia.hardware.power.statecontrol.Admin'
  FIDL API to send the reboot command.
  ```

By default, target boots fully. This behavior can be overrided by passing
in either `--bootloader` or `--recovery` to boot into the bootloader or
recovery, respectively.

'fuchsia.hardware.power.statecontrol.Admin' is exposed by the 'power_manager'
component. To verify that the target exposes this service, `ffx component
select` or `ffx component knock` can be used.

| **Errors** |   |
|---|---|
| 1 | Timeout while powering off target. |

### remove

Make the daemon forget a specific target


    Usage:  ffx target remove [--all] [name_or_addr]

| **Options** |   |
|---|---|
| --help | display usage information |
| --all | remove all manually added targets |

**Examples**

```
To remove a target by its target name:

    $ ffx target remove correct-horse-battery-staple

Or to remove a target using its IP address:

    $ ffx target remove fe80::32fd:38ff:fea8:a00a
```

**Notes**

-

  ```
  IP addresses are matched by their full string representation.
  for best results, copy the exact address from ffx target list.
  ```

### repository

Interact with target repository registration


    Usage:  ffx target repository [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [deregister](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_repository_deregister) | Make the target forget a specific repository |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_repository_list) | List all the repositories on a target |
| [register](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_repository_register) | Make the target aware of a specific repository |
| [rule](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_repository_rule) | Configure rewriting rules on a target |

**Notes**

-

  ```
  The `repository` subcommand contains various commands for repository management
  and interaction on targets.

  Most of the commands depend on the RCS (Remote Control Service) on the target.
  ```

#### deregister

Make the target forget a specific repository


    Usage:  ffx target repository deregister [-r <repository>] [-p <port>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --repository | remove the repository named `name` from the target, rather than the default. |
| -p, --port | repository server port number. Required to disambiguate multiple repositories with the same name. |

#### list

List all the repositories on a target


    Usage:  ffx target repository list

| **Options** |   |
|---|---|
| --help | display usage information |

#### register

Make the target aware of a specific repository


    Usage:  ffx target repository register [-r <repository>] [-p <port>] [--address-override <address-override>] [--storage-type <storage-type>] [--alias <alias...>] [--alias-conflict-mode <alias-conflict-mode>] [--json-uri <json-uri>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -r, --repository | register this repository, rather than the default. |
| -p, --port | repository server port number. Required to disambiguate multiple repositories with the same name. |
| --address-override | repository server address override. When provided, overrides the server address registered on the target. Required when the server's listening address is not directly reachable by the target. |
| --storage-type | enable persisting this repository across reboots. |
| --alias | set up a rewrite rule mapping each `alias` host to to the repository identified by `name`. |
| --alias-conflict-mode | resolution mechanism when alias registrations conflict. Must be either `error-out` or `replace`. Default is `replace`. |
| --json-uri | register a repository on the target device from a configuration in a json file. Must be either a path or an URL. Note that ffx will not manage this repository automatically. This flag is mutually exclusive with the other flags, since it reads all repo config data from the provided configuration file. |

#### rule

Configure rewriting rules on a target


    Usage:  ffx target repository rule [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [replace](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_repository_rule_replace) | Replace all dynamic rules with the provided rules |

##### replace

Replace all dynamic rules with the provided rules


    Usage:  ffx target repository rule replace [-u <json-uri>] [-r <rule>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -u, --json-uri | read the rules from a configuration in a json file. Must be either a path or an URL. This is mutually exclusive with the `rule` option. |
| -r, --rule | read the rules from a string provided in the argument. Must be valid JSON. This is mutually exclusive with the `json_uri` option. |

### screenshot

Takes a screenshot of the target


    Usage:  ffx target screenshot [-d <dir>] [--format <format>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -d, --dir | override the default directory where the screenshot will be saved |
| --format | screenshot format. If no value is provided bgra will be used. |

        Accepted values: bgra, rgba, png

**Examples**

```
Store the target's screenshot in a directory:

    $ ffx target screenshot -d .
    Exported ./screenshot
```

**Notes**

-

      This command connects to a running target to take its screenshot.
      The --dir can be supplied to override the default
      screenshot saving location /tmp/screenshot/YYYYMMDD_HHMMSS/.
      The --format can be supplied to override the default format png.
      Accepted format values: bgra, rgba, png.
      The screenshot file name is screenshot.<format>.

### shell

open a developer shell to a target device


    Usage:  ffx target shell shell_command

| **Options** |   |
|---|---|
| --help | display usage information |

### show

Display relevant information for the target


    Usage:  ffx target show [--desc] [--label]

| **Options** |   |
|---|---|
| --help | display usage information |
| --desc | display descriptions of entries |
| --label | display label of entries |

**Notes**

-

  ```
  Displays a detailed information about the target.
  ```

The default output is intended for a human reader. This output can be
decorated with machine readable labels (--label) and descriptions of
each field (--desc).

The 'label' fields in the machine readable output (--json) will remain
stable across software updates and is not localized (compare to 'title'
which may change or be localized). The 'value' field will be one of:
'null', 'bool', 'string', or a list of strings.

| **Errors** |   |
|---|---|
| 1 | Timeout retrieving target information. |

### snapshot

Takes a snapshot of the target's state


    Usage:  ffx target snapshot [-d <dir>] [--dump-annotations] [--upload]

| **Options** |   |
|---|---|
| --help | display usage information |
| -d, --dir | valid directory where the snapshot will be stored |
| --dump-annotations | print annotations without capturing the snapshot, ignores `dir` and `upload` flags |
| --upload | whether to upload the generated snapshot to a predefined GCS bucket |

**Examples**

```
Store the target's snapshot in the current directory:

    $ ffx target snapshot -d .
    Exported ./snapshot.zip
```

**Notes**

-

      This command connects to a running target to acquire its snapshot, which contains
      useful debugging information about the target. The --dir can be supplied to override the default
      snapshot directory /tmp/snapshots/YYYYMMDD_HHMMSS/.

Snapshot contents:
- Build information and annotations
- Kernel and system logs
- Inspect data

### ssh

SSH to a target device


    Usage:  ffx target ssh [--sshconfig <sshconfig>] [command...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --sshconfig | path to the custom ssh config file to use. |

**Examples**

```
To ssh to a specific device:

    $ ffx -t fuchsia-EEEE-NNNN target ssh

To ssh and run a command:

    $ ffx target ssh 'echo $USER'
```

### status

Run status checks step by step to determine a device's state


    Usage:  ffx target status [proxy_connect_timeout]

| **Options** |   |
|---|---|
| --help | display usage information |

### update

Update base system software on target


    Usage:  ffx target update [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [channel](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update_channel) | View and manage update channels |
| [check-now](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update_check-now) | Check and perform the system update operation |
| [force-install](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update_force-install) | Trigger the system updater manually |
| [wait-for-commit](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update_wait-for-commit) | Wait for the update to be committed. |

**Notes**

-

  ```
  This command interfaces with system update services on the target.
  ```

#### channel

View and manage update channels


    Usage:  ffx target update channel [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [get-current](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update_channel_get-current) | Return the currently configured update channel |
| [get-next](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update_channel_get-next) | Return the next or target update channel |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update_channel_list) | List the known update channels |
| [set](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_target_update_channel_set) | Sets the update channel |

**Notes**

-

  ```
  Channel management commands and operations. Interfaces directly with
  the 'fuchsia.update.channelcontrol.ChannelControl' service on the target
  system.
  ```

##### get-current

Return the currently configured update channel


    Usage:  ffx target update channel get-current

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  For developer product configurations, this is by default 'devhost'.
  ```

| **Errors** |   |
|---|---|
| 1 | Timeout while getting update channel. |

##### get-next

Return the next or target update channel


    Usage:  ffx target update channel get-next

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

      Returns the next or target channel. This differs from get when the
      next successful update changes the configured update channel on the
      system.

| **Errors** |   |
|---|---|
| 1 | Timeout while getting update channel. |

##### list

List the known update channels


    Usage:  ffx target update channel list

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  This lists all the known next or target update channels on the system.
  ```

Returns an empty list if no other update channels are configured.

| **Errors** |   |
|---|---|
| 1 | Timeout while getting list of update channel. |

##### set

Sets the update channel


    Usage:  ffx target update channel set channel

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To list all the known update channels:

    $ ffx target update channel list

Then, use a valid channel from the list:

    $ ffx target update channel set 
```

**Notes**

-

      Sets the next or target update channel on the device. When paired with
      ffx target update check-now, ensures the update is check against the
      next or target channel. When the update is successful, next or target
      channel becomes the current channel.

Use `ffx target update channel list` to list known system update
channels.

| **Errors** |   |
|---|---|
| 1 | Timeout while setting update channel. |

#### check-now

Check and perform the system update operation


    Usage:  ffx target update check-now [--service-initiated] [--monitor] [--product-bundle] [--product-bundle-port <product-bundle-port>] [product_bundle_path]

| **Options** |   |
|---|---|
| --help | display usage information |
| --service-initiated | the update check was initiated by a service, in the background. |
| --monitor | monitor for state update. |
| --product-bundle | use the product bundle to use as the source of the update. |
| --product-bundle-port | port to start the OTA repo server on when using --product_bundle. This is configured by `repository.ota_port` and defaults to 0, which indicates a random unassigned port. |

**Examples**

```
To check for update and monitor progress:

    $ ffx target update check-now --monitor
```

**Notes**

-

  ```
  Triggers an update check operation and performs the update if available.
  Interfaces using the 'fuchsia.update Manager' protocol with the system
  update service on the target.
  ```

The command takes in an optional `--monitor` switch to watch the progress
of the update. The output is displayed in `stdout`.

The command also takes an optional `--service-initiated` switch to indicate
a separate service has initiated a check for update.

#### force-install

Trigger the system updater manually


    Usage:  ffx target update force-install [--reboot <reboot>] [--product-bundle] [--product-bundle-port <product-bundle-port>] [--product-bundle-path <product-bundle-path>] [--packageless] [update_url]

| **Options** |   |
|---|---|
| --help | display usage information |
| --reboot | automatically trigger a reboot into the new system |
| --product-bundle | use the product bundle to use as the source of the update. |
| --product-bundle-port | port to start the OTA repo server on when using --product_bundle. This is configured by `repository.ota_port` and defaults to 0, which indicates a random unassigned port. |
| --product-bundle-path | optionally specify the product bundle to use as the source of the update, implies `--product-bundle`. The default is to use the product bundle configured with `product.path`. |
| --packageless | use a default packageless update url if no update_url is provided |

**Examples**

```
With a known update package URL, trigger an update and reboot:

    $ ffx target update force-install fuchsia-pkg://fuchsia.com/update

Don't reboot after update:

    $ ffx target update force-install
    fuchsia-pkg://fuchsia.com/update
    --reboot false
```

**Notes**

-

  ```
  Directly invoke the system updater to install the provided update,
  bypassing any update checks.
  ```

Interfaces using the 'fuchsia.update.installer' protocol to update the
system. Requires an in the following format:

`fuchsia-pkg://fuchsia.com/update`

Takes an optional `--reboot <true|false>` to trigger a system reboot
after update has been successfully applied.

#### wait-for-commit

Wait for the update to be committed.


    Usage:  ffx target update wait-for-commit

| **Options** |   |
|---|---|
| --help | display usage information |

### wait

Wait for a target to reach a specific state.


    Usage:  ffx target wait [-t <timeout>] [-d] [--state <state>]

| **Options** |   |
|---|---|
| --help | display usage information |
| -t, --timeout | the timeout in seconds \[default = 120\]. A value of 0 implies no timeout. |
| -d, --down | wait for target to go down |
| --state | wait for the target to reach a specific state ('down', 'up', 'fastboot', 'product') |

| **Errors** |   |
|---|---|
| 1 | Timeout while waiting for target |

### wipe

Performs a factory data reset


    Usage:  ffx target wipe [--force]

| **Options** |   |
|---|---|
| --help | display usage information |
| --force | reset without prompting for confirmation |

**Notes**

-

  ```
  Performs a factory data reset. Uses the 'fuchsia.recovery.FactoryReset' FIDL API to send the reset command.
  ```

## test

Run test suite


    Usage:  ffx test [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [early-boot-profile](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_test_early-boot-profile) | Manage early boot profiles |
| [list-cases](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_test_list-cases) | List test suite cases |
| [run](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_test_run) | Execute test suites on a target device |

**Notes**

-

  ```
  Run tests or inspect output from a previous test run.
  ```

### early-boot-profile

Manage early boot profiles


    Usage:  ffx test early-boot-profile --output-directory <output-directory>

| **Options** |   |
|---|---|
| --help | display usage information |
| --output-directory | output early boot profile to the specified directory. The produced output is in the format described in https://fuchsia.dev/fuchsia-src/reference/platform-spec/testing/test-output-format |

### list-cases

List test suite cases


    Usage:  ffx test list-cases [--realm <realm>] test_url

| **Options** |   |
|---|---|
| --help | display usage information |
| --realm | the realm to enumerate the test in. This field is optional and takes the form: /path/to/realm:test_collection. |

**Notes**

-

  ```
  Lists the set of test cases available in a test suite
  ```

### run

Execute test suites on a target device


    Usage:  ffx test run [--pilot <pilot>] [--test-file <test-file>] [-t <timeout>] [--test-filter <test-filter...>] [--realm <realm>] [--run-disabled] [--parallel <parallel>] [--max-severity-logs <max-severity-logs>] [--continue-on-timeout] [--stop-after-failures <stop-after-failures>] [--count <count>] [--experimental-parallel-execution <experimental-parallel-execution>] [--break-on-failure] [--filter-ansi] [--min-severity-logs <min-severity-logs...>] [--show-full-moniker-in-logs] [--output-directory <output-directory>] [--disable-output-directory] [--no-exception-channel] [--no-cases-equals-success] [--capture-syslog] [test_args...]

| **Options** |   |
|---|---|
| --help | display usage information |
| --pilot | read test parameters from the specified file instead of from the command line. This is intended to be used by test_pilot. |
| --test-file | read test url and options from the specified file instead of from the command line. May not be used in conjunction with `test_args`, `--count`, `--test-filter`, `--run-disabled`, `--parallel`, `--max-severity-logs` This option is currently unstable and the format of the file is subject to change. Using this option requires setting the 'test.experimental_json_input' configuration to true. For current details, see test-list.json format at https://fuchsia.googlesource.com/fuchsia/+/refs/heads/main/src/lib/testing/test_list/ |
| -t, --timeout | test suite timeout in seconds. |
| --test-filter | test case filter. This filter will match based on glob pattern. This option may be specified multiple times. Only test cases matching at least one pattern will be run. Negative filters may be specified by prepending '-' and will exclude matching test cases. |
| --realm | the realm to run the test in. This field is optional and takes the form: /path/to/realm:test_collection. See https://fuchsia.dev/go/components/non-hermetic-tests |
| --run-disabled | also execute test cases that have been disabled by the test author. |
| --parallel | maximum number of test cases to run in parallel. Defaults to a value specified by the test runner. |
| --max-severity-logs | when set, fails tests that emit logs with a higher severity. For example, if --max-severity-logs WARN is specified, fails any test that produces an ERROR level log. |
| --continue-on-timeout | continue running unfinished suites if a suite times out. This option is only relevant when multiple suites are run. |
| --stop-after-failures | stop running unfinished suites after the number of provided failures has occurred. This option is only relevant when multiple suites are run. |
| --count | number of times to run the test suite. By default run the suite 1 time. |
| --experimental-parallel-execution | enables experimental parallel test scheduler. The provided number specifies the max number of test suites to run in parallel. If the value provided is 0, a default value will be chosen by the server implementation. |
| --break-on-failure | enable break_on_failure for supported test runners. Any test case failure causes the test execution to stop and wait for zxdb to attach to debug the failure. When the debugger exits, the process will be released and the suite will be continued. Note: test runners may or may not have the ability to halt a test suite after it has started executing. If there isn't a way to raise an exception for a debugger to catch, the test will run and exit as normal, and will not wait for any debugger interaction. |
| --filter-ansi | filter ANSI escape sequences from output. |
| --min-severity-logs | set the minimum log severity printed. This modifies the minimum log severity level emitted by components during the test execution. Specify using the format #, or just (in which case the severity will apply to all components under the test, including the test component itself) with level as one of FATAL |
| --show-full-moniker-in-logs | show the full moniker in unstructured log output. |
| --output-directory | output test results to the specified directory. The produced output is in the format described in https://fuchsia.dev/fuchsia-src/reference/platform-spec/testing/test-output-format |
| --disable-output-directory | disable structured output to a directory. Note structured output is disabled by default, unless --output-directory is specified. This option supported an experiment which has been removed. It is now a no-op and will soon be removed. |
| --no-exception-channel | when set, prevents test_manager from creating exception channels that may confilict with those created by the test. |
| --no-cases-equals-success | when set, the test_filter selecting an empty set of cases to run is treated as success rather than failure. |
| --capture-syslog | indicates whether a syslog that covers the duration of the test run should be captured in the test output. |

**Examples**

```
Run a test suite:
    $ ffx test run fuchsia-pkg://fuchsia.com/my_test#meta/my_test.cm

Run a test suite in system realm:
    $ ffx test run --realm /core/testing/system-tests fuchsia-pkg://fuchsia.com/my_test#meta/my_test.cm

Run a test suite and pass arguments to the suite:
    $ ffx test run fuchsia-pkg://fuchsia.com/my_test#meta/my_test.cm -- arg1 arg2

Run test suites specified in a JSON file (currently unstable):
    $ ffx test run --test-file test-list.json

Given a suite that contains the test cases 'Foo.Test1', 'Foo.Test2',
'Bar.Test1', and 'Bar.Test2':

Run test cases that start with 'Foo.' ('Foo.Test1', 'Foo.Test2'):
    $ ffx test run  --test-filter 'Foo.*'

Run test cases that do not start with 'Foo.' ('Bar.Test1', 'Bar.Test2'):
    $ ffx test run  --test-filter '-Foo.*'

Run test cases that start with 'Foo.' and do not end with 'Test1' ('Foo.Test2'):
    $ ffx test run  --test-filter 'Foo.*' --test-filter '-*.Test1'
```

**Notes**

-

      Runs test suites implementing the fuchsia.test.Suite protocol.

When multiple test suites are run, either through the --count option or through
--test-file, the default behavior of ffx test is:
If any test suite times out, halt execution and do not attempt to run any
unstarted suites.
If any test suite fails for any other reason, continue to run unstarted
suites.

## trace

Collect, aggregate, and visualize traces


    Usage:  ffx trace [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [list-categories](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace_list-categories) | List the target's known trace categories. |
| [list-category-groups](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace_list-category-groups) | List the builtin and custom category groups. |
| [list-providers](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace_list-providers) | List the target's trace providers. |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace_start) | Record a trace. |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace_status) | Gets status of all running traces. |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace_stop) | Stops an active running trace. |
| [symbolize](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace_symbolize) | Symbolizes the provided ordinal |
| [upload](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_trace_upload) | Upload a trace file to GCS and display the Perfetto Trace Viewer URL. |

**Examples**

```
\[Quick Start]:

    $ ffx trace start \[--duration  ]

This will record a trace using the default categories, which are suitable for getting a high
level overview.

This will produce a file `trace.fxt` which can be uploaded to ui.perfetto.dev to be viewed.
```

**Notes**

-

  ```
  Tracing is a tool that allows you to collect, aggregate, and visualize diagnostic
  tracing information from both userspace processes and the Zircon kernel on a Fuchsia device.
  ```

For a full tutorial, visit https://fuchsia.dev/fuchsia-src/development/sdk/ffx/record-traces.

### list-categories

List the target's known trace categories.


    Usage:  ffx trace list-categories

| **Options** |   |
|---|---|
| --help | display usage information |

### list-category-groups

List the builtin and custom category groups.


    Usage:  ffx trace list-category-groups

| **Options** |   |
|---|---|
| --help | display usage information |

### list-providers

List the target's trace providers.


    Usage:  ffx trace list-providers

| **Options** |   |
|---|---|
| --help | display usage information |

### start

Record a trace.


    Usage:  ffx trace start [--buffering-mode <buffering-mode>] [--buffer-size <buffer-size>] [--categories <categories>] [--duration <duration>] [--output <output>] [--background] [-v] [--on-boot] [--trigger <trigger...>] [--no-symbolize] [--no-verify-trace] [--retain-raw-fidl] [--compressed] [--upload] [--bucket <bucket>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --buffering-mode | the buffering scheme to trace with. Defaults to "oneshot" oneshot: Writes to the tracing buffer until it is full, then ignores all additional trace events. circular: Writes to the tracing buffer until its is full, then new events will replace old events. streaming: Forwards tracing events to the trace manager as they arrive. Provides additional buffer space with the trade off of some overhead due to occasional ipcs to send the events to the trace manager during the trace. |
| --buffer-size | size of per-provider trace buffer in MB. Defaults to 4. |
| --categories | comma-separated list of categories to enable. Defaults to "#default". Run `ffx config get trace.category_groups.default` to see what categories are included in #default. A trailing "*" may be used to indicate a prefix match. For example, "kernel* " includes any category that starts with kernel. A name prefixed with # indicates a category group that will be expanded from ffx config within the plugin *before* being sent to trace manager. A category group can either be added to global config by editing data/config.json in the ffx trace plugin, or by using ffx config set to add/edit a user configured category group. Available category groups can be discovered by running `ffx config get -s all trace.category_groups` A category may be limited to a specific trace provider using a '/'. For example --categories "scenic.cm/FrameDropped" will only enable the "FrameDropped" category for the scenic.cm trace provider and no other providers. Categories and category groups may be mixed, for example, ffx trace start --categories #default,my_category Enables all the default categories as well as "my_category". |
| --duration | duration of trace capture in seconds. |
| --output | name of output trace file. Defaults to trace.fxt. Cannot be used with --background. To specify the output file with background mode, pass --output to `ffx trace stop` instead." |
| --background | whether to run the trace in the background. Defaults to false, which means the trace will run in "interactive" mode. For a trace started in the background for a specified duration, symbolization is not done by default. |
| -v, --verbose | increase verbosity of output on trace stop. Defaults to false. This is ignored if duration is not set. Enabling this prints stats from trace providers including the number of records dropped, wrapped buffers count, % of durable buffer used and non durable bytes written. |
| --on-boot | send request to start tracing when the device reboots. This trace can be downloaded once the device is ready using `ffx trace stop`. |
| --trigger | a trigger consists of an alert leading to an action. An alert is written into the code being traced, and an action here is what to do when the alert has happened. The list of supported actions are: 'terminate'. The expected format is ":" ex: -trigger "my_alert:terminate" This can be used with a duration, but keep in mind that this introduces a race between whether the alert leads to an action, and when the trace stops from the duration being reached. Triggers can only be used in the background outside of interactive mode. |
| --no-symbolize | prevent symbolization of the trace file. Defaults to false. If the 'kernel:ipc' category is not included in tracing, this flag does nothing. Otherwise this flag will prevent the symbolization of the kernel IPC traces, leaving the ordinals as is in the trace. This flag is only used if tracing is manually stopped. |
| --no-verify-trace | prevent checking the trace data when stopping tracing. Defaults to false. If this flag is enabled, trace result analysis will not be triggered. |
| --retain-raw-fidl | retain raw FIDL-related trace arguments after symbolization. Defaults to false. |
| --compressed | keep the trace file compressed on the host. Defaults to false. |
| --upload | upload the trace file to GCS and display the Perfetto Trace Viewer URL. Defaults to false. |
| --bucket | GCS bucket to upload the trace file to. |

**Examples**

```
\[Quick Start]:

    $ ffx trace start \[--duration  ]

This will record a trace using the default categories, which are suitable for getting a high
level overview.

This will produce a file `trace.fxt` which can be uploaded to ui.perfetto.dev to be viewed.

\[Trace Various Categories]:

    $ ffx trace start --categories '#default,flatland:*,temp'

This will record a trace with all the default categories enabled, 'temp' events enabled, and any
event that starts with 'flatland:'


\[Capturing a Sporadic Occurrence]

    $ ffx trace start --buffer-size 64 --buffering-mode circular

This will run the trace with the largest available buffer size, overwriting the old events with new
ones. When the event occurs press  to stop the trace.


\[Automatically Capturing a Sporadic Occurrence with a Trigger]

This approach allows you to automatically stop the trace when the event happens, but the traced
code must already be set up to write a trigger event.

    $ ffx trace start --buffer-size 64 --buffering-mode circular --trigger ':terminate'
```

**Notes**

-

  ```
  For a full tutorial, visit https://fuchsia.dev/fuchsia-src/development/sdk/ffx/record-traces
  ```

### status

Gets status of all running traces.


    Usage:  ffx trace status

| **Options** |   |
|---|---|
| --help | display usage information |

### stop

Stops an active running trace.


    Usage:  ffx trace stop [--output <output>] [-v] [--no-symbolize] [--no-verify-trace] [--retain-raw-fidl] [--abort] [--compressed] [--upload] [--bucket <bucket>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --output | name of output trace file. Relative or absolute paths are both supported. If this is not supplied (the default), then the default target will be used as the method to stop the trace. |
| -v, --verbose | increase verbosity of command output. Defaults to false. Enabling this prints stats from trace providers including the number of records dropped, wrapped buffers count, % of durable buffer used and non durable bytes written. |
| --no-symbolize | prevent symbolization of the trace file. Defaults to false. If the 'kernel:ipc' category is not included in tracing, this flag does nothing. Otherwise this flag will prevent the symbolization of the kernel IPC traces, leaving only the ordinals in the trace. |
| --no-verify-trace | prevent checking the trace data when stopping tracing. Defaults to false. If this flag is enabled, trace result analysis will not be triggered. |
| --retain-raw-fidl | retain raw FIDL-related trace arguments after symbolization. Defaults to false. |
| --abort | stop the currently running background trace session. Discard the trace data. Defaults to false. |
| --compressed | keep the trace file compressed on the host. Defaults to false. |
| --upload | upload the trace file to GCS and display the Perfetto Trace Viewer URL. Defaults to false. |
| --bucket | GCS bucket to upload the trace file to. |

### symbolize

Symbolizes the provided ordinal


    Usage:  ffx trace symbolize [--ordinal <ordinal>] [--fxt <fxt>] [--outfile <outfile>] [--ir-path <ir-path...>] [--retain-raw-fidl]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ordinal | FIDL ordinal to be symbolized. |
| --fxt | trace file to be symbolized. |
| --outfile | symbolized file path. Defaults to overwriting the input file. |
| --ir-path | additional IR files to use for symbolization. Path provided must be absolute or relative to $FUCHSIA_BUILD_DIR. If not provided, only the files listed in $FUCHSIA_BUILD_DIR/all_fidl_json.txt will be checked. |
| --retain-raw-fidl | retain raw FIDL-related trace arguments after symbolization. Defaults to false. |

### upload

Upload a trace file to GCS and display the Perfetto Trace Viewer URL.


    Usage:  ffx trace upload [--bucket <bucket>] [trace_file]

| **Options** |   |
|---|---|
| --help | display usage information |
| --bucket | GCS bucket to upload the trace file to. |

## triage

Analyze Logs and Inspect in snapshots to find problems.


    Usage:  ffx triage [--config <config...>] [--data <data>] [--tag <tag...>] [--exclude-tag <exclude-tag...>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --config | path to config file or dir |
| --data | path to snapshot.zip or uncompressed dir |
| --tag | adds an action tags to include |
| --exclude-tag | adds an action tags to exclude |

## uart

Interact with the UART subsystem.


    Usage:  ffx uart [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [connect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_uart_connect) | Start a background driver daemon to connect to a UART target |
| [disconnect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_uart_disconnect) | Stop the driver daemon and disconnect from a UART target |
| [doctor](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_uart_doctor) | Diagnose and repair UART connection issues |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_uart_list) | List active UART connections |
| [probe](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_uart_probe) | Probe a UART target connection health |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_uart_status) | Show real-time connection status and metrics for a UART target |

**Notes**

-

  ```
  Most commands require a target (via the global 'ffx -t  uart ...' flag).
  If no target is specified, commands (except 'connect') will implicitly target
  the active connection if exactly one is running.
  ```

### connect

Start a background driver daemon to connect to a UART target


    Usage:  ffx uart connect [--baud <baud>] [--socket <socket>] [--reconnect] [--protocol <protocol>] [--no-retry]

| **Options** |   |
|---|---|
| --help | display usage information |
| --baud | baud rate for the UART port (default: 1000000, only used for TTY targets) |
| --socket | custom UNIX socket path to use |
| --reconnect | reconnect if already connected (reclaims stale daemon) |
| --protocol | protocol to use: "resend" (ResendSP) |
| --no-retry | do not retry connection if it fails or is lost |

**Notes**

-

  ```
  ffx-uart uses "-t " just as with any other ffx command, although the "uart:" prefix is optional.
  ```

Examples:
ffx -t uart:/dev/ttyUSB0 uart connect
ffx -t /dev/ttyUSB0 uart connect

If you have configured a default target (e.g. via 'ffx target default set uart:...'), you can omit the '-t' flag:
ffx uart connect

Supported target formats:
- Connect directly to a TTY device or UNIX socket path (e.g. "/dev/ttyUSB0", "/tmp/socket")

Target strings may optionally be prefixed with "uart:" (e.g. "uart:/dev/ttyUSB0"), which will be stripped.

### disconnect

Stop the driver daemon and disconnect from a UART target


    Usage:  ffx uart disconnect

| **Options** |   |
|---|---|
| --help | display usage information |

### doctor

Diagnose and repair UART connection issues


    Usage:  ffx uart doctor [--fix]

| **Options** |   |
|---|---|
| --help | display usage information |
| --fix | automatically fix detected issues where possible |

### list

List active UART connections


    Usage:  ffx uart list

| **Options** |   |
|---|---|
| --help | display usage information |

### probe

Probe a UART target connection health


    Usage:  ffx uart probe [--baud <baud>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --baud | baud rate for the UART port (default: 1000000, only used for TTY targets) |

### status

Show real-time connection status and metrics for a UART target


    Usage:  ffx uart status

| **Options** |   |
|---|---|
| --help | display usage information |

## uart-driver

Driver daemon for UART transport


    Usage:  ffx uart-driver [--background] [--log-dir <log-dir>] --target <target> [--socket <socket>] [--baud <baud>] [--no-retry]

| **Options** |   |
|---|---|
| --help | display usage information |
| --background | run the driver in the background |
| --log-dir | directory where log files should be stored |
| --target | target UART port path (TTY or UNIX socket) |
| --socket | path to the UNIX socket where the driver will listen for clients |
| --baud | baud rate for the UART port (only used for TTY targets) |
| --no-retry | do not retry connection if it fails or is lost |

## usb

Collect and view telemetry for USB controllers and devices


    Usage:  ffx usb [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [diagnostics](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_usb_diagnostics) | Inspect USB health and diagnostics on the target device |

### diagnostics

Inspect USB health and diagnostics on the target device


    Usage:  ffx usb diagnostics [-H] [-i] [-a] [-v]

| **Options** |   |
|---|---|
| --help | display usage information |
| -H, --health | query and print the fuchsia.usb.policy.Health report (default mode if no flags are specified) |
| -i, --inspect | query and print device-side USB Inspect diagnostics |
| -a, --all | query and print all available USB diagnostics (both health and inspect) |
| -v, --verbose | print verbose health details |

## usb-driver

Drive USB devices to/from ffx


    Usage:  ffx usb-driver [--background] [--log-dir <log-dir>] [--serial <serial>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --background | whether to fork the driver process into the background rather than run |
| --log-dir | directory where log file should be placed |
| --serial | only allow this driver daemon to see the device with the given serial number |

## verify-ssh-keys

Check target access keys in $FUCHSIA_DIR, \~/.ssh, or agent.


    Usage:  ffx verify-ssh-keys

| **Options** |   |
|---|---|
| --help | display usage information |

**Notes**

-

  ```
  Checks the device's authorized keys to determine whether we have any of the available
  public keys locally.
  ```

Also, checks for public keys in the fuchsia directory (if set in $FUCHSIA_DIR), the home directory
under `.ssh` and also checks the ssh agent.

## version

Print out ffx tool and daemon versions


    Usage:  ffx version [-v]

| **Options** |   |
|---|---|
| --help | display usage information |
| -v, --verbose | if true, includes details about both ffx and the daemon |

## wlan

Developer tool for manipulating WLAN state.


    Usage:  ffx wlan [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [ap](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_ap) | Controls WLAN AP policy API. |
| [client](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client) | Controls WLAN client policy API. |
| [deprecated](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_deprecated) | Controls to-be-deleted WLAN functionality. |

### ap

Controls WLAN AP policy API.


    Usage:  ffx wlan ap [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [listen](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_ap_listen) | Listens for policy AP updates |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_ap_start) | Start an access point interface |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_ap_status) | Provides the first available AP status update |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_ap_stop) | Stop an access point interface |
| [stop-all](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_ap_stop-all) | Stops all active APs |

#### listen

Listens for policy AP updates


    Usage:  ffx wlan ap listen

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To begin listening for AP events

    $ ffx wlan ap listen
```

#### start

Start an access point interface


    Usage:  ffx wlan ap start [--ssid <ssid>] [--security-type <security-type>] [--credential-type <credential-type>] [--credential <credential>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ssid | WLAN network name |
| --security-type | one of None, WEP, WPA, WPA2, WPA3 |
| --credential-type | one of None, PSK, Password |
| --credential | WLAN Password or PSK |

**Examples**

```
To start an AP

    $ffx wlan ap start

        --ssid TestNetwork

        --security-type wpa2

        --credential-type password

        --credential "Your very secure password here"
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy layer.
  ```

#### status

Provides the first available AP status update


    Usage:  ffx wlan ap status

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To query current AP status

    $ ffx wlan ap status
```

#### stop

Stop an access point interface


    Usage:  ffx wlan ap stop [--ssid <ssid>] [--security-type <security-type>] [--credential-type <credential-type>] [--credential <credential>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ssid | WLAN network name |
| --security-type | one of None, WEP, WPA, WPA2, WPA3 |
| --credential-type | one of None, PSK, Password |
| --credential | WLAN Password or PSK |

**Examples**

```
To stop an AP

    $ffx wlan ap stop

        --ssid TestNetwork

        --security-type wpa2

        --credential-type password

        --credential "Your very secure password here"
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy layer.
  ```

#### stop-all

Stops all active APs


    Usage:  ffx wlan ap stop-all

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To stop all APs

    $ ffx wlan ap stop-all
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy layer.
  ```

### client

Controls WLAN client policy API.


    Usage:  ffx wlan client [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [batch-config](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_batch-config) | Allows WLAN credentials to be extracted and restored. |
| [connect](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_connect) | Connect to the specified WLAN network |
| [forget-network](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_forget-network) | WLAN policy network storage container |
| [list-saved-networks](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_list-saved-networks) | Lists all networks saved by the WLAN policy layer. |
| [listen](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_listen) | Listens for policy client connections updates |
| [save-network](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_save-network) | WLAN policy network storage container |
| [scan](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_scan) | Scan for nearby WLAN networks. |
| [start](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_start) | Allows wlancfg to automate WLAN client operation |
| [status](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_status) | Provides the first available client status update |
| [stop](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_stop) | Stops automated WLAN policy control of client interfaces and |

#### batch-config

Allows WLAN credentials to be extracted and restored.


    Usage:  ffx wlan client batch-config [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [dump](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_batch-config_dump) | Extracts a structured representation of the device's saved WLAN credentials. |
| [restore](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_client_batch-config_restore) | Injects a structure representation of WLAN credentials into a device. |

##### dump

Extracts a structured representation of the device's saved WLAN credentials.


    Usage:  ffx wlan client batch-config dump

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To dump WLAN client configs

    $ ffx wlan client batch-config dump
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy layer.
  ```

##### restore

Injects a structure representation of WLAN credentials into a device.


    Usage:  ffx wlan client batch-config restore serialized_config

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To restore WLAN client configs

    $ ffx wlan client batch-config restore 
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy layer.
  ```

#### connect

Connect to the specified WLAN network


    Usage:  ffx wlan client connect [--ssid <ssid>] [--security-type <security-type>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ssid | WLAN network name |
| --security-type | one of None, WEP, WPA, WPA2, WPA3 |

**Examples**

```
To remove a WLAN network

    $ffx wlan client connect

        --ssid TestNetwork

        --security-type wpa2
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy layer.
  ```

#### forget-network

WLAN policy network storage container


    Usage:  ffx wlan client forget-network [--ssid <ssid>] [--security-type <security-type>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ssid | WLAN network name |
| --security-type | one of None, WEP, WPA, WPA2, WPA3 |

**Examples**

```
To forget a WLAN network

    $ffx wlan client forget-network

        --ssid TestNetwork

        --security-type wpa2
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy layer.
  ```

#### list-saved-networks

Lists all networks saved by the WLAN policy layer.


    Usage:  ffx wlan client list-saved-networks

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To list saved networks

    $ ffx wlan client list-saved-networks
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy
  layer.
  ```

#### listen

Listens for policy client connections updates


    Usage:  ffx wlan client listen

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To begin listening for client events

    $ ffx wlan client listen
```

#### save-network

WLAN policy network storage container


    Usage:  ffx wlan client save-network [--ssid <ssid>] [--security-type <security-type>] [--credential-type <credential-type>] [--credential <credential>]

| **Options** |   |
|---|---|
| --help | display usage information |
| --ssid | WLAN network name |
| --security-type | one of None, WEP, WPA, WPA2, WPA3 |
| --credential-type | one of None, PSK, Password |
| --credential | WLAN Password or PSK |

**Examples**

```
To save a WLAN network

    $ffx wlan client save-network

        --ssid TestNetwork

        --security-type wpa2

        --credential-type password

        --credential "Your very secure password here"
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy layer.
  ```

#### scan

Scan for nearby WLAN networks.


    Usage:  ffx wlan client scan

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To scan

    $ ffx wlan client scan
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy
  layer.
  ```

#### start

Allows wlancfg to automate WLAN client operation


    Usage:  ffx wlan client start

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To start client connections

    $ ffx wlan client start
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy
  layer.
  ```

#### status

Provides the first available client status update


    Usage:  ffx wlan client status

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To query client status

    $ ffx wlan client status
```

#### stop

Stops automated WLAN policy control of client interfaces and
destroys all client interfaces.


    Usage:  ffx wlan client stop

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To stop client connections

    $ ffx wlan client stop
```

**Notes**

-

  ```
  Only one application at a time can interact with the WLAN policy
  layer.
  ```

### deprecated

Controls to-be-deleted WLAN functionality.


    Usage:  ffx wlan deprecated [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [suggest-mac](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wlan_deprecated_suggest-mac) | Notifies WLAN policy of a MAC address that ought to be used when creating new AP interfaces |

#### suggest-mac

Notifies WLAN policy of a MAC address that ought to be used when creating new AP interfaces


    Usage:  ffx wlan deprecated suggest-mac mac

| **Options** |   |
|---|---|
| --help | display usage information |

**Examples**

```
To suggest an AP MAC address

    $ ffx wlan deprecated suggest-mac 01:02:03:04:05:06
```

## wm

Control views presented by the window manager.


    Usage:  ffx wm [subcommand...]

| **Options** |   |
|---|---|
| --help | display usage information |

| **Subcommands** |   |
|---|---|
| [cycle](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wm_cycle) | Shift all views forward by one position, view at position 0 is moved to the end. |
| [focus](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wm_focus) | Focus the position and viewId of all windows currently presented in the session. |
| [list](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wm_list) | List the position and viewId of all windows currently presented in the session. |
| [set-order](https://fuchsia.dev/reference/tools/sdk/ffx.md.txt#ffx_wm_set-order) | Re-order the window currently at `old_position` to be placed at `new_position`. |

**Notes**

-

      The wm subcommand contains various commands that allow us to manipulate and inspect
      views being presented by the window manager component.

### cycle

Shift all views forward by one position, view at position 0 is moved to the end.


    Usage:  ffx wm cycle

| **Options** |   |
|---|---|
| --help | display usage information |

### focus

Focus the position and viewId of all windows currently presented in the session.


    Usage:  ffx wm focus position

| **Options** |   |
|---|---|
| --help | display usage information |

### list

List the position and viewId of all windows currently presented in the session.


    Usage:  ffx wm list

| **Options** |   |
|---|---|
| --help | display usage information |

### set-order

Re-order the window currently at `old_position` to be placed at `new_position`.


    Usage:  ffx wm set-order old-position new-position

| **Options** |   |
|---|---|
| --help | display usage information |