Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make clear the requirement of the [cli] dependency group for the schema exporter #3728

Merged
merged 2 commits into from
Dec 16, 2024
+3 −0
Merged

Make clear the requirement of the [cli] dependency group for the schema exporter #3728

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6da4431
Update schema-export.md
shaggyz Dec 16, 2024
0e5e70a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/guides/schema-export.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ schema definition.
Strawberry provides a command to export your schema definition. The exported
schema will be described in the GraphQL schema definition language (SDL).

To use the command line tools, you have to ensure Strawberry was installed with `strawberry-graphql[cli]`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Consider adding the specific pip install command for clarity

It would be helpful to include the actual pip install command (e.g., pip install 'strawberry-graphql[cli]') to make it even easier for users to get started.

Suggested change
To use the command line tools, you have to ensure Strawberry was installed with `strawberry-graphql[cli]`.
To use the command line tools, you have to ensure Strawberry was installed with the CLI extras:
```bash
pip install 'strawberry-graphql[cli]'


You can export your schema using the following command:

```bash
Expand Down