CLI Usage¶
This page covers all suite graphql commands, their flags, and common usage patterns.
Commands¶
suite graphql config¶
Configures the Fusion subgraph metadata for one or more backend services. Sets the subgraph name and the HTTP endpoint the gateway will use to reach the service at runtime.
| Bash | |
|---|---|
This step is automatically run as part of suite graphql compose. Run it independently
only if you need to update subgraph metadata without regenerating schemas.
suite graphql schema¶
Starts each backend service in design time mode, exports its GraphQL schema, and packages
it into a .fsp (Fusion Subgraph Package) for each BFF it publishes to.
| Bash | |
|---|---|
| Option | Description |
|---|---|
--dotnet-run-extra-args |
Extra arguments passed to dotnet run when starting the service to export its schema. Useful for passing environment-specific settings. |
This step is automatically run as part of suite graphql compose. Run it independently
if you need to regenerate subgraph schemas without recomposing the BFF gateway.
suite graphql compose¶
Runs the full Fusion composition pipeline — config, schema generation, and gateway composition — for one or more applications.
| Bash | |
|---|---|
| Option | Description |
|---|---|
--no-subgraphs |
Skips Steps 1 (config) and 2 (schema generation) and composes the BFF gateway using the existing .fsp packages. Use this when subgraph schemas have not changed and only the gateway needs to be recomposed. |
--dotnet-run-extra-args |
Extra arguments passed to dotnet run during schema generation. Has no effect when used together with --no-subgraphs. |
Common Patterns¶
Recompose everything for a BFF after multiple backend changes:
| Bash | |
|---|---|
Recompose only after changing a single backend service:
| Bash | |
|---|---|
Recompose a BFF gateway without regenerating subgraph schemas:
| Bash | |
|---|---|
Regenerate schemas only, without composing the gateway:
| Bash | |
|---|---|