| # The ffx tool | |
| `ffx` provides a unified platform for Fuchsia CLI tools for host target | |
| interactions. It introduces a service oriented interface to many common | |
| development and integration workflow operations that users may wish to | |
| perform against one or more Fuchsia target devices. | |
| It is both a service runtime, and a collection of utilities, and it is | |
| intended for both users and infrastructure integrators alike. | |
| ## Getting started for users | |
| Start with the [user guide][getting-started] for using the `ffx` tool. | |
| ## Getting started for developers | |
| When extending or adding a subtool for `ffx` it is important to | |
| consider the following: | |
| - `ffx` is developed in Rust and makes heavy use of rust crates. However, | |
| crates must be hosted in the [Fuchsia Platform Source Tree][fuchsia-source]. | |
| This process is detailed in Open Source Review Board (OSRB) | |
| [process][osrb-process] document. Review existing crates in | |
| [`third_party/rust_crates`][rust-crates]. | |
| - When extending `ffx`, review the existing command surface by running | |
| `ffx help` to understand where the new command or tool may fit. | |
| - When extending an existing command, consider adding a flag or an option. | |
| However, if the overall workflow enabled does not exist, consider a | |
| new command or a higher level subgrouping. | |
| - Consider the dependencies such as which FIDL services, local filesystem | |
| entries, target filesystem paths, or any manifests/manifest formats | |
| the tool depends on. | |
| - Consider how the command interacts with multiple devices. `ffx` provides | |
| a global `--target` to explicitly declare which device to interact with. | |
| - Does the command need access to configurations or depend on a specific | |
| build environment? If so, take advantage of the various configuration | |
| settings within `ffx` or define new ones for the specific command or | |
| workflow. Existing configurations can be accessed via `ffx config get`. | |
| A detailed guide with examples is available in | |
| [Developing for FFX][developing-ffx]. | |
| ## CLI | |
| The command-line interface ([CLI][cli-doc]) provides the UX for `ffx`. | |
| It is responsible for: | |
| - Parsing user parameters (CLI parameters) | |
| - Routing parsed parameters and requested FIDL proxies to the proper code path | |
| for execution | |
| ## Remote control service | |
| The remote control service runs on target devices and is responsible | |
| for providing access to the FIDL services running on the target. | |
| ## FDomain | |
| FDomain is a mechanism for communicating with FIDL services on a Fuchsia target | |
| device from a development host machine. It was designed to replace the Overnet | |
| protocol. For more details, see the [FDomain overview][fdomain-overview]. | |
| <!-- Reference links --> | |
| [getting-started]: /docs/development/tools/ffx/getting-started.md | |
| [fuchsia-source]: https://fuchsia.googlesource.com | |
| [osrb-process]: /docs/contribute/governance/policy/osrb-process.md | |
| [rust-crates]: /third_party/rust_crates | |
| [developing-ffx]: /docs/development/tools/ffx/development/subtools/getting-started.md | |
| [cli-doc]: /docs/development/tools/ffx/architecture/cli.md | |
| [fdomain-overview]: /docs/development/tools/ffx/fdomain.md |