-
-
Notifications
You must be signed in to change notification settings - Fork 744
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added command line documentation (#6160)
- Loading branch information
1 parent
1da0ee3
commit d7bb2d4
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Command Line | ||
--- | ||
|
||
# Overview | ||
The `HotChocolate.AspNetCore.CommandLine` package extends the `IHostBuilder` interface, offering a command-line interface for managing GraphQL schemas. | ||
This extension provides a seamless experience for developers, allowing them to export their schemas directly from the command line, which can be beneficial for CI/CD. | ||
|
||
# Setup the Command Line Interface | ||
|
||
Here's an example of using the `HotChocolate.AspNetCore.CommandLine` package with a minimal API and a simple setup: | ||
|
||
```csharp | ||
var builder = WebApplication.CreateBuilder(args); | ||
|
||
builder.Services.AddGraphQLServer().AddQueryType<Query>(); | ||
|
||
var app = builder.Build(); | ||
|
||
app.MapGraphQL(); | ||
|
||
app.RunWithGraphQLCommandsAsync(args); | ||
``` | ||
|
||
# Commands | ||
|
||
## Schema Export Command | ||
|
||
The `schema export` command exports the GraphQL schema. By default, the schema is printed to the console. However, you can specify an output file using the `--output` option. | ||
|
||
```shell | ||
dotnet run -- schema export --output schema.graphql | ||
``` | ||
|
||
**Options** | ||
|
||
- `--output`: The path to the file where the schema should be exported. If no output path is specified, the schema will be printed to the console. | ||
- `--schema-name`: The name of the schema to be exported. If no schema name is specified, the default schema will be exported. |