ffx

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx [-c ] [-e ] [-t ] [-T ] [-v] [] [] Fuchsia’s developer tool

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -c, --config      override default configuration
  7.   -e, --env         override default environment settings
  8.   -t, --target      apply operations across single or multiple targets
  9.   -T, --timeout     override default proxy timeout
  10.   -v, --verbose     use verbose output
  11.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

component Discover and manage components config View and switch default and user configurations daemon Interact with/control the ffx daemon doctor Run common checks for the ffx tool and host environment vdl Start and manage Fuchsia emulators overnet Interact with the Overnet mesh package Create and publish Fuchsia packages platform Manage platform build prerequisites scrutiny Audit the security of Fuchsia sdk Modify or query the installed SDKs self-test Execute the ffx self-test (e2e) suite target Interact with a target device or emulator trace Interact with the tracing subsystem version Print out ffx tool and daemon versions debug Start a debugging session.

  2. ## component
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx component <command> [<args>]
  7. Discover and manage components

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   knock             Connect to a service on the target
  7.   list              List all components
  8.   run               Run a component on the target
  9.   select            Lists components matching a selector
  10.   test              Run test suite

knock

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx component knock Connect to a service on the target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Examples:
  8.   To connect to a service:
  9.       $ ffx component knock 'core/appmgr:out:fuchsia.hwinfo.Product'
  10. Notes:
  11.   Knock verifies the existence of a service exposed by a component by
  12.   attempting to connect to it. The command expects a <selector> with the
  13.   following format:
  14.   `<component moniker>:(in|out|exposed)[:<service name>].`
  15.   Note that wildcards can be used but must match exactly one service.
  16.   The `component select` command can be used to explore the component
  17.   topology to compose the correct selector for use in `component knock`.
  18. Error codes:
  19.   1 Failed to connect to service

list

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx component list List all components

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Examples:
  8.   To list all components in the topology:
  9.       $ ffx component list
  10. Notes:
  11.   Lists all the components on the running target. The command outputs a
  12.   tree of all v1 and v2 components on the system.
  13.   If the command fails or times out, ensure RCS is running on the target.
  14.   This can be verified by running `ffx target list` and seeing the status
  15.   on the RCS column.
  16. Error codes:
  17.   1 The command has timed out

run

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx component run [] Run a component on the target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Examples:
  8.   To run the 'hello_world_rust' component:
  9.       $ ffx component run \
  10.       fuchsia-pkg://fuchsia.com/hello_world_rust#meta/hello_world_rust.cmx
  11.   To run the Remote Control Service:
  12.       $ ffx component run \
  13.       fuchsia-pkg://fuchsia.com/remote-control#meta/remote-control-runner.cmx
  14. Notes:
  15.   Runs a specified v1 component on the target. The <url> must follow the
  16.   format:
  17.   `fuchsia-pkg://fuchsia.com/<package>#meta/<component>.cmx`.

select

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx component select Lists components matching a selector

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Examples:
  8.   To show services exposed by remote-control:
  9.       $ ffx component select remote-control:expose:*'
  10.   Or to show all services offered by v1 components:
  11.       $ ffx component select core/appmgr:out:*
  12. Notes:
  13.   Component select allows for looking up various services exposed by the
  14.   component. The command expects a <selector> with the following format:
  15.   `<component moniker>:(in|out|exposed)[:<service name>]`
  16.   Wildcards may be used anywhere in the selector.
  17. Error codes:
  18.   1 No matching component paths found

test

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx component test [-t ] [—test-filter ] [—list] [—run-disabled] [—parallel ] [—count ] Run test suite

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -t, --timeout     test timeout
  7.   --test-filter     a glob pattern for matching tests
  8.   --list            list tests in the suite
  9.   --run-disabled    run tests that have been marked disabled/ignored
  10.   --parallel        run tests in parallel
  11.   --count           number of times to run the test [default = 1]
  12.   --help            display usage information
  13. Notes:
  14.   Runs a test or suite implementing the `fuchsia.test.Suite` protocol.
  15.   Note that if running multiple iterations of a test and an iteration times
  16.   out, no further iterations will be executed.

config

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx config [] View and switch default and user configurations

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

env list environment settings get display config values set set config settings remove remove config for a given level add add config value the end of an array analytics enable or disable analytics

  2. ### add
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx config add <name> <value> [-l <level>] [-b <build-dir>]
  7. add config value the end of an array

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

-l, —level config level. Possible values are “user”, “build”, “global”. Defaults to “user”. -b, —build-dir an optional build directory to associate the build config provided - use used for “build” configs —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.

  2. ### analytics
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx config analytics <command> [<args>]
  7. enable or disable analytics

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   enable            enable analytics
  7.   disable           disable analytics
  8.   show              show analytics

disable

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx config analytics disable disable analytics

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

enable

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx config analytics enable enable analytics

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

show

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx config analytics show show analytics

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

env

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx config env [] [] list environment settings

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

set set environment settings get list environment for a given level

  2. #### get
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx config env get [<level>]
  7. list environment for a given level

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. #### set
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx config env set <file> [-l <level>] [-b <build-dir>]
  7. set environment settings

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

-l, —level config level. Possible values are “user”, “build”, “global”. Defaults to “user”. -b, —build-dir an optional build directory to associate the build config provided - use used for “build” configs —help display usage information

  2. ### get
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx config get [<name>] [-p <process>] [-s <select>] [-b <build-dir>] [-o <output>]
  7. display config values

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

-p, —process how to process results. Possible values are “raw”, “sub”, and “sub_flat”. Defaults to “raw”. Currently only supported if a name is given. -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. -b, —build-dir an optional build directory to associate the build config provided - use used for “build” configs -o, —output [DEPRECATED] The output type will always be JSON. —help display usage information Error codes: 2 No value found

  2. ### remove
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx config remove <name> [-l <level>] [-b <build-dir>]
  7. remove config for a given level

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

-l, —level config level. Possible values are “user”, “build”, “global”. Defaults to “user”. -b, —build-dir an optional build directory to associate the build config provided - use used for “build” configs —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.

  2. ### set
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx config set <name> <value> [-l <level>] [-b <build-dir>]
  7. set config settings

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

-l, —level config level. Possible values are “user”, “build”, “global”. Defaults to “user”. -b, —build-dir an optional build directory to associate the build config provided - use used for “build” configs —help display usage information

  2. ## daemon
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx daemon <command> [<args>]
  7. Interact with/control the ffx daemon

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   crash             crash the daemon
  7.   echo              run echo test against the daemon
  8.   log               Dumps the daemon log
  9.   start             run as daemon
  10.   stop              stops a running daemon

crash

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx daemon crash crash the daemon

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

echo

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx daemon echo [] run echo test against the daemon

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

log

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx daemon log Dumps the daemon log

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

start

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx daemon start run as daemon

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

stop

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx daemon stop stops a running daemon

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

debug

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx debug [] Start a debugging session.

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

doctor

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx doctor [—retry-count ] [—retry-delay ] [—restart-daemon] [—record] [—record-output ] Run common checks for the ffx tool and host environment

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --retry-count     number of times to retry failed connection attempts.
  7.   --retry-delay     timeout delay when attempting to connect to the daemon or
  8.                     RCS
  9.   --restart-daemon
  10.                     if true, forces a daemon restart, even if the connection
  11.                     appears to be working
  12.   --record          if true, generates an output zip file that can be attached
  13.                     to a monorail issue
  14.   --record-output   sets the output directory for doctor records. Only valid
  15.                     when --record is provided. Defaults to the current directory
  16.   --help            display usage information

overnet

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx overnet [] Interact with the Overnet mesh

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

list-peers List known peer nodes list-links List links on a particular peer host-pipe Use stdin/stdout as a link to another overnet instance full-map Construct a detailed graphviz map of the Overnet mesh - experts only!

  2. ### full-map
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx overnet full-map --exclude-self <exclude-self>
  7. Construct a detailed graphviz map of the Overnet mesh - experts only!

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—exclude-self if set, exclude the onet tool from output —help display usage information

  2. ### host-pipe
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx overnet host-pipe
  7. Use stdin/stdout as a link to another overnet instance

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. ### list-links
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx overnet list-links <nodes>
  7. List links on a particular peer

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. ### list-peers
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx overnet list-peers
  7. List known peer nodes

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. ## package
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx package <command> [<args>]
  7. Create and publish Fuchsia packages

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   build             Builds a package.
  7. Entries may be specified as:
  8. -
  9.                     <dst>=<src>: Place the file at path <src> into the package
  10.                     at path <dst>.
  11. - @<manifest-file>: Read each line of this
  12.                     file as an entry. This is not recursive; you can't put
  13.                     another @<manifest-file>
  14.   export            export a package archive
  15.   import            import a package archive

build

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx package build [] [—source-dir ] [—hash-out ] [—depfile ] Builds a package. Entries may be specified as:

  • =: Place the file at path into the package at path .
  • @: Read each line of this file as an entry. This is not recursive; you can’t put another @ ```

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—source-dir base directory for the part of entries; defaults to the current directory —hash-out write the package hash to this file instead of stdout —depfile write a gcc-format depfile for use in build systems —help display usage information

  2. ## platform
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx platform <command> [<args>]
  7. Manage platform build prerequisites

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   preflight         Evaluate suitability for building and running Fuchsia

preflight

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx platform preflight Evaluate suitability for building and running Fuchsia

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

scrutiny

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx scrutiny [] Audit the security of Fuchsia

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

shell Run the scrutiny shell

  2. ### shell
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx scrutiny shell [<command>]
  7. Run the scrutiny shell

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. ## sdk
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx sdk <command> [<args>]
  7. Modify or query the installed SDKs

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   version           Retrieve the version of the current SDK

version

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx sdk version Retrieve the version of the current SDK

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

self-test

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx self-test [—timeout ] [—case-timeout ] [—include-target ] Execute the ffx self-test (e2e) suite

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --timeout         maximum runtime of entire test suite in seconds
  7.   --case-timeout    maximum run time of a single test case in seconds
  8.   --include-target  include target interaction tests
  9.   --help            display usage information

target

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target [] Interact with a target device or emulator

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

add Make the daemon aware of a specific target default Manage the default target flash Flash an image to a target device get-ssh-address Get the target’s ssh address list List all targets log
off Powers off a target reboot Reboots a target remove Make the daemon forget a specific target status Display status information for the target update Update base system software on target 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.

  2. ### add
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx target add <addr>
  7. Make the daemon aware of a specific target

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information 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.

  2. ### default
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx target default <command> [<args>]
  7. Manage the default target

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   get               Get the default configured target
  7.   set               Set the default target
  8.   unset             Clears the default configured target
  9. Examples:
  10.   For one-off overrides for the default use `--target` option:
  11.       $ ffx --target <target name> <subcommand>
  12.   Or use the `--config` option:
  13.       $ ffx --config target.default=<target name> <subcommand>
  14. Notes:
  15.   Manages the default configured target for all operations. The default
  16.   target is designated by a `*` next to the name. This is an alias for the
  17.   `target.default` configuration key.

get

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target default get Get the default configured target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Notes:
  8.   Returns the default configured target from the 'User Configuration'.
  9.   Returns an empty string if no default is configured.

set

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target default set [-l ] [-b ] Set the default target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -l, --level       config level, such as 'user', 'build', or 'global'
  7.   -b, --build-dir   optional directory to associate the provided build config
  8.   --help            display usage information
  9. Examples:
  10.   To set the default target:
  11.      $ ffx target default set <target name>
  12.   To set the 'target.default` key at the global configuration:
  13.      $ ffx target default set -l global <target name>
  14.   To specify a default target for a specific build directory:
  15.      $ ffx target default set -l build -b ~/fuchsia/out <target name>
  16. Notes:
  17.   Sets the `target.default` configuration key. By default sets the key in
  18.   the 'User Configuration'. Can be used in conjuction with `ffx target list`
  19.   to list the names of the discovered targets.
  20.   After setting the default target, `ffx target list` will mark the default
  21.   with a `*` in the output list.

unset

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target default unset [-l ] [-b ] Clears the default configured target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -l, --level       config level, such as 'user', 'build', or 'global'
  7.   -b, --build-dir   optional directory to associate the provided build config
  8.   --help            display usage information
  9. Examples:
  10.   To clear the default target:
  11.       $ ffx target default unset
  12.   To clear the `target.default` key from global configuration:
  13.       $ ffx target default unset -l global
  14.   To specify a specific build directory:
  15.       $ ffx target default unset -l build -b ~/fuchsia/out
  16. Notes:
  17.   Clears the `target.default` configuration key. By default clears the
  18.   'User Configuration'. Returns a warning if the key is already empty.

flash

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target flash [] [—oem-stage ] Flash an image to a target device

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --oem-stage       oem staged file - can be supplied multiple times
  7.   --help            display usage information
  8. Examples:
  9.   To flash a specific image:
  10.       $ ffx target flash ~/fuchsia/out/flash.json fuchsia
  11.   To include SSH keys as well:
  12.       $ ffx target flash
  13.       --oem-stage add-staged-bootloader-file ssh.authorized_keys,
  14.       ~/fuchsia/.ssh/authorized_keys
  15.       ~/fuchsia/out/default/flash.json
  16.        fuchsia
  17. Notes:
  18.   Flases an image to a target device using the fastboot protocol.
  19.   Requires a specific <manifest> file and <product> name as an input.
  20.   This is only applicable to a physical device and not an emulator target.
  21.   The target device is typically connected via a micro-USB connection to
  22.   the host system.
  23.   The <manifest> format is a JSON file generated when building a fuchsia
  24.   <product> and can be found in the build output directory.
  25.   The `--oem-stage` option can be supplied multiple times for several OEM
  26.   files. The format expects a single OEM command to execute after staging
  27.   the given file.
  28.   The format for the `--oem-stage` parameter is a comma separated pair:
  29.   '<OEM_COMMAND>,<FILE_TO_STAGE>'

get-ssh-address

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target get-ssh-address [-t ] Get the target’s ssh address

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -t, --timeout     the timeout in seconds [default = 1.0]
  7.   --help            display usage information
  8. Notes:
  9.   Return the SSH address of the default target defined in the
  10.   `target.default` key. By default this comes from the 'User Configuration'.
  11.   The command takes a <timeout> value in seconds with a default of `1.0`
  12.   and overrides the value in the `target.interaction.timeout` key.
  13. Error codes:
  14.   1 Timeout while getting ssh address

list

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target list [] [-f ] List all targets

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -f, --format      determines the output format for the list operation
  7.   --help            display usage information
  8. Examples:
  9.   To list targets in short form:
  10.       $ ffx target list --format s
  11.       fe80::4415:3606:fb52:e2bc%zx-f80ff974f283 pecan-guru-clerk-rhyme
  12.   To list targets with only their addresses:
  13.       $ ffx target list --format a
  14.       fe80::4415:3606:fb52:e2bc%zx-f80ff974f283
  15. Notes:
  16.   List all targets that the daemon currently has in memory. This includes
  17.   manually added targets. The daemon also proactively discovers targets as
  18.   they come online. Use `ffx target list` to always get the latest list
  19.   of targets.
  20.   The default target is marked with a '*' next to the node name. The table
  21.   has the following columns:
  22.       NAME = The name of the target.
  23.       TYPE = The product type of the target, currently always 'Unknown'.
  24.       STATE = The high-level state of the target, currently always 'Unknown'.
  25.       AGE = Shows the last time the daemon was able to discover the target.
  26.       ADDRS/IP = The discovered and known addresses of the target.
  27.       RCS = Indicates if the Remote Control Service is running on the target.
  28.   The NAME column shows the target's advertised name. When the target is
  29.   in early boot state such as fastboot, shows 'FastbootDevice' with the
  30.   `product` and `serial` attributes instead.
  31.   By default, the `list` command outputs in a tabular format. To override
  32.   the format, pass `--format` and can take the following options: 'simple'
  33.   , 'tabular|table|tab', 'addresses|addrs|addr', 'json|JSON' or in short form 's', 't',
  34.    'a', 'j'.

log

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target log []

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

watch Watches for and prints logs from a target. Optionally dumps recent logs first. dump Dumps all logs from a target.

  2. #### dump
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx target log dump
  7. Dumps all logs from a target.

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. #### recent
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Unrecognized argument: recent

watch

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target log watch [—dump ] Watches for and prints logs from a target. Optionally dumps recent logs first.

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --dump            if true, dumps recent logs before printing new ones.
  7.   --help            display usage information

off

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target off Powers off a target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Notes:
  8.   Power off a target. Uses the 'fuchsia.hardware.power.statecontrol.Admin'
  9.   FIDL API to send the power off command.
  10.   The 'fuchsia.hardware.power.statecontrol.Admin' is exposed via the 'appmgr'
  11.   component. To verify that the target exposes this service, `ffx component
  12.   select` or `ffx component knock` can be used.
  13. Error codes:
  14.   1 Timeout while powering off target.

reboot

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target reboot [-b] [-r] Reboots a target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -b, --bootloader  reboot to bootloader
  7.   -r, --recovery    reboot to recovery
  8.   --help            display usage information
  9. Notes:
  10.   Reboot a target. Uses the 'fuchsia.hardware.power.statecontrol.Admin'
  11.   FIDL API to send the reboot command.
  12.   By default, target boots fully. This behavior can be overrided by passing
  13.   in either `--bootloader` or `--recovery` to boot into the bootloader or
  14.   recovery, respectively.
  15.   The 'fuchsia.hardware.power.statecontrol.Admin' is exposed via the 'appmgr'
  16.   component. To verify that the target exposes this service, `ffx component
  17.   select` or `ffx component knock` can be used.
  18. Error codes:
  19.   1 Timeout while powering off target.

remove

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target remove Make the daemon forget a specific target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Examples:
  8.   To remove a target by its target name:
  9.       $ ffx target remove correct-horse-battery-staple
  10.   Or to remove a target using its IP address:
  11.       $ ffx target remove fe80::32fd:38ff:fea8:a00a
  12. Notes:
  13.   IP addresses are matched by their full string representation.
  14.   for best results, copy the exact address from ffx target list.

status

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target status [—desc] [—label] [—json] [—version] Display status information for the target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --desc            display descriptions of entries
  7.   --label           display label of entries
  8.   --json            formats output as json objects
  9.   --version         display version
  10.   --help            display usage information
  11. Notes:
  12.   Displays a detailed runtime status information about the target.
  13.   The default output is intended for a human reader. This output can be
  14.   decorated with machine readable labels (--label) and descriptions of
  15.   each field (--desc).
  16.   The 'label' fields in the machine readable output (--json) will remain
  17.   stable across software updates and is not localized (compare to 'title'
  18.   which may change or be localized). The 'value' field will be one of:
  19.   'null', 'bool', 'string', or a list of strings.
  20. Error codes:
  21.   1 Timeout retrieving target status.

update

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target update [] Update base system software on target

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

channel View and manage update channels check-now Check and perform the system update operation force-install Trigger the system updater manually Notes: This command interfaces with system update services on the target.

  2. #### channel
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx target update channel <command> [<args>]
  7. View and manage update channels

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   get-current       Return the currently configured update channel
  7.   get-next          Return the next or target update channel
  8.   set               Sets the update channel
  9.   list              List the known update channels
  10. Notes:
  11.   Channel management commands and operations. Interfaces directly with
  12.   the 'fuchsia.update.channelcontrol.ChannelControl' service on the target
  13.   system.
get-current

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target update channel get-current Return the currently configured update channel

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Notes:
  8.   For developer product configurations, this is by default 'devhost'.
  9. Error codes:
  10.   1 Timeout while getting update channel.
get-next

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target update channel get-next Return the next or target update channel

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Notes:
  8.   Returns the next or target channel. This differs from `get` when the
  9.   next successful update changes the configured update channel on the
  10.   system.
  11. Error codes:
  12.   1 Timeout while getting update channel.
list

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target update channel list List the known update channels

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Notes:
  8.   This lists all the known next or target update channels on the system.
  9.   Returns an empty list if no other update channels are configured.
  10. Error codes:
  11.   1 Timeout while getting list of update channel.
set

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target update channel set Sets the update channel

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information
  7. Examples:
  8.   To list all the known update channels:
  9.       $ ffx target update channel list
  10.   Then, use a valid channel from the list:
  11.       $ ffx target update channel set <channel>
  12. Notes:
  13.   Sets the next or target update channel on the device. When paired with
  14.   `ffx target update check-now`, ensures the update is check against the
  15.   next or target channel. When the update is successful, next or target
  16.   channel becomes the current channel.
  17.   Use `ffx target update channel list` to list known system update
  18.   channels.
  19. Error codes:
  20.   1 Timeout while setting update channel.

check-now

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target update check-now [—service-initiated] [—monitor] Check and perform the system update operation

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --service-initiated
  7.                     the update check was initiated by a service, in the
  8.                     background.
  9.   --monitor         monitor for state update.
  10.   --help            display usage information
  11. Examples:
  12.   To check for update and monitor progress:
  13.       $ ffx target update check-now --monitor
  14. Notes:
  15.   Triggers an update check operation and performs the update if available.
  16.   Interfaces using the 'fuchsia.update Manager' protocol with the system
  17.   update service on the target.
  18.   The command takes in an optional `--monitor` switch to watch the progress
  19.   of the update. The output is displayed in `stdout`.
  20.   The command also takes an optional `--service-initiated` switch to indicate
  21.   a separate service has initiated a check for update.

force-install

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx target update force-install [—reboot ] Trigger the system updater manually

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --reboot          automatically trigger a reboot into the new system
  7.   --help            display usage information
  8. Examples:
  9.   With a known update package URL, trigger an update:
  10.       $ ffx target update force-install fuchsia-pkg://fuchsia.com/update
  11.   Also trigger a reboot after update:
  12.       $ ffx target update force-install
  13.       fuchsia-pkg://fuchsia.com/update
  14.       --reboot
  15. Notes:
  16.   Directly invoke the system updater to install the provided update,
  17.   bypassing any update checks.
  18.   Interfaces using the 'fuchsia.update.installer' protocol to update the
  19.   system. Requires an <update_pkg_url> in the following format:
  20.   `fuchsia-pkg://fuchsia.com/update`
  21.   Takes an optional `--reboot <true|false>` to trigger a system reboot
  22.   after update has been successfully applied.

trace

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx trace [] Interact with the tracing subsystem

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   --help            display usage information

Commands:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

list-providers List the target’s trace providers record Record a trace

  2. ### list-providers
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx trace list-providers
  7. List the target's trace providers

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—help display usage information

  2. ### record
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx trace record [--buffer-size <buffer-size>] [--categories <categories>] [--duration <duration>] [--output <output>]
  7. Record a trace

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—buffer-size size of per-provider trace buffer in MB. Defaults to 4. —categories comma-separated list of categories to enable. Defaults to “app,audio,benchmark,blobfs,gfx,input,kernel:meta, kernel:sched,ledger,magma,minfs,modular,view,flutter, dart,dart:compiler,dart:dart,dart:debugger,dart:embedder, dart:gc,dart:isolate,dart:profiler,dart:vm” —duration duration of trace capture in seconds. Defaults to 10 seconds. —output name of output trace file. Defaults to trace.fxt. —help display usage information

  2. ## vdl
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6. Usage: ffx vdl [--sdk] <command> [<args>]
  7. Start and manage Fuchsia emulators

Options:

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

—sdk running in fuchsia sdk (not inside the fuchsia code repository) —help display usage information

  2. __Commands:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   start             Starting Fuchsia Emulator
  7.   kill              Killing Fuchsia Emulator

kill

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx vdl kill [-d ] [—launched-proto ] Killing Fuchsia Emulator

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -d, --vdl-path    device_launcher binary location. Defaults to looking in
  7.                     prebuilt/vdl/device_launcher
  8.   --launched-proto  required, file containing device_launcher process artifact
  9.                     location.
  10.   --help            display usage information

start

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx vdl start [-H] [-N] [—host-gpu] [—software-gpu] [—hidpi-scaling] [-u ] [—packages-to-serve ] [-p ] [-w ] [-h ] [-s ] [-f ] [-e ] [—aemu-version ] [-d ] [—vdl-version ] [-x ] [-X ] [—grpcwebproxy-version ] [-v ] [—gcs-bucket ] [—image-name ] [-l ] [—port-map ] [—vdl-output ] [—nointeractive] Starting Fuchsia Emulator

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -H, --headless    bool, run emulator in headless mode.
  7.   -N, --tuntap      bool, run emulator with emulated nic via tun/tap.
  8.   --host-gpu        bool, run emulator with host GPU acceleration, this doesn't
  9.                     work on remote-desktop with --headless.
  10.   --software-gpu    bool, run emulator without host GPU acceleration, default.
  11.   --hidpi-scaling   bool, enable pixel scaling on HiDPI devices.
  12.   -u, --upscript    path to tun/tap upscript, this script will be executed
  13.                     before booting up FEMU.
  14.   --packages-to-serve
  15.                     comma separated string of fuchsia package urls, extra
  16.                     packages to serve after starting FEMU.
  17.   -p, --pointing-device
  18.                     set pointing device used on emulator: mouse or touch screen.
  19.                     Allowed values are "touch", "mouse". Default is "touch".
  20.   -w, --window-width
  21.                     emulator window width. Default to 1280.
  22.   -h, --window-height
  23.                     emulator window height. Default to 800.
  24.   -s, --image-size  extends storage size to <size> bytes. Default is "2G".
  25.   -f, --device-proto
  26.                     path to fuchsia virtual device configuration, if not
  27.                     specified a generic one will be generated.
  28.   -e, --aemu-path   path to aemu location. When running in fuchsia repo,
  29.                     defaults to looking in prebuilt/third_party/aemu/PLATFORM.
  30.                     When running in fuchsia sdk, defaults to looking in
  31.                     $HOME/.fuchsia/femu.
  32.   --aemu-version    label used to download AEMU from CIPD. Default is
  33.                     "integration". Download only happens if aemu binary cannot
  34.                     be found from known paths.
  35.   -d, --vdl-path    device_launcher binary location. When running in fuchsia
  36.                     repo, defaults to looking in prebuilt/vdl/device_launcher.
  37.                     When running in fuchsia sdk, defaults to looking in
  38.                     directory containing `fvdl`.
  39.   --vdl-version     label used to download vdl from CIPD. Default is "latest".
  40.                     Download only happens if vdl (device_launcher) binary cannot
  41.                     be found from known paths.
  42.   -x, --grpcwebproxy
  43.                     enable WebRTC HTTP service on port, if set to 0 a random
  44.                     port will be picked
  45.   -X, --grpcwebproxy-path
  46.                     location of grpcwebproxy, When running in fuchsia repo,
  47.                     defaults to looking in prebuilt/third_party/grpcwebproxy
  48.                     When running in fuchsia sdk, defaults to looking in
  49.                     $HOME/.fuchsia/femu.
  50.   --grpcwebproxy-version
  51.                     label used to download grpcwebproxy from CIPD. Default is
  52.                     "latest". Download only happens if --grpcwebproxy is set and
  53.                     grpcwebproxy binary cannot be found from known paths or path
  54.                     specified by --grpcwebproxy_path.
  55.   -v, --sdk-version fuchsia sdk ID used to fetch from gcs, if specified, the
  56.                     emulator will launch with fuchsia sdk files fetched from
  57.                     gcs. To find the latest version run `gsutil cat
  58.                     gs://fuchsia/development/LATEST_LINUX`.
  59.   --gcs-bucket      gcs bucket name. Default is "fuchsia".
  60.   --image-name      image file name used to fetch from gcs. Default is
  61.                     "qemu-x64". To view availabe image names run `gsutil ls -l
  62.                     gs://fuchsia/development/$(gsutil cat
  63.                     gs://fuchsia/development/LATEST_LINUX)/images`.
  64.   -l, --emulator-log
  65.                     file path to store emulator log. Default is a temp file that
  66.                     is deleted after `fvdl` exits.
  67.   --port-map        host port mapping for user-networking mode. This flag will
  68.                     be ignored if --tuntap is used. If not specified, an ssh
  69.                     port on host will be randomly picked and forwarded. ex:
  70.                     hostfwd=tcp::<host_port>-:<guest_port>,hostfwd=tcp::<host_port>-:<guest_port>
  71.   --vdl-output      file destination to write `device_launcher` output. Required
  72.                     for --nointeractive mode. Default is a temp file that is
  73.                     deleted after `fvdl` exits. Specify this flag if you plan to
  74.                     use the `kill` subcommand.
  75.   --nointeractive   bool, turn off interactive mode. if turned off, fvdl will
  76.                     not land user in ssh console. A ssh port will still be
  77.                     forwarded. User needs to specify --vdl-output flag with this
  78.                     mode, and manually call the `kill` subcommand to perform
  79.                     clean shutdown.
  80.   --help            display usage information

version

```none {: style=”white-space: break-spaces;” .devsite-disable-click-to-copy}

Usage: ffx version [-v] Print out ffx tool and daemon versions

  2. __Options:__
  4. ```none {: style="white-space: break-spaces;" .devsite-disable-click-to-copy}
  6.   -v, --verbose     if true, includes details about both ffx and the daemon
  7.   --help            display usage information