Grafbase Command Line Arguments

Commands that let you manipulate graph branches.

Creates a new branch for a graph.

Usage:

grafbase branch create <BRANCH_REF>

Arguments:

• <BRANCH_REF>: Branch reference that uses the format account/graph@branch.

Removes a branch from a graph.

Usage:

grafbase branch remove <BRANCH_REF>

Arguments:

• <BRANCH_REF>: Branch reference that uses the format account/graph@branch.

Checks a graph to locate validation, composition, and breaking change errors.

Usage:

grafbase check [OPTIONS] --name <SUBGRAPH_NAME> <PROJECT_REF>

Arguments:

• <PROJECT_REF>: Project reference that uses the format account/graph@branch.

Options:

• --name <SUBGRAPH_NAME>: Subgraph name to check.
• --schema <SCHEMA_FILE>: Path to the schema file to check. If this is not provided, the schema will be read from standard input.

Grafbase generates shell completion scripts for various shells. Put the file in your shell's location.

Generate a bash completion script.

Usage:

grafbase completions bash

Generate an elvish completion script.

grafbase completions elvish

Generate a fish completion script.

grafbase completions fish

Generate a PowerShell completion script.

grafbase completions powershell

Generate a zsh completion script.

Create a new graph.

Usage:

grafbase create [OPTIONS]

Options:

• -n, --name <NAME>: Specify the graph name.
• -a, --account <ACCOUNT>: Specify the account slug to create the graph.

Gets and displays the schema of a graph.

Usage:

grafbase introspect [OPTIONS] <URL>

Arguments:

• <URL>: URL of the graph to introspect.

Options:

• -H, --header [<HEADER>...]: HTTP header to include in the introspection request.
• --no-color: Disable color output.

Lints a GraphQL schema.

Usage:

grafbase lint [SCHEMA]

Arguments:

• [SCHEMA]: Path to the schema file to lint.

Log in to your Grafbase account.

Usage:

grafbase login

Log out of your Grafbase account.

Usage:

grafbase logout

Publishes a subgraph schema.

Usage:

grafbase publish [OPTIONS] --name <SUBGRAPH_NAME> --url <URL> <PROJECT_REF>

Arguments:

• <PROJECT_REF>: Project reference that uses the format account/graph@branch.

Options:

• --name <SUBGRAPH_NAME>: Subgraph name to publish.
• --schema <SCHEMA_PATH>: Path to the schema file to publish. If this is not provided, the schema will be read from standard input.
• --url <URL>: The URL to the GraphQL endpoint of the subgraph.
• -m, --message <MESSAGE>: Commit message for the schema change.

Example:

Use the publish command with either a schema file or the standard output from another Grafbase command. To publish a schema from a remote graph, combine the introspect and publish commands.

grafbase introspect http://localhost:4000/graphql \
    | grafbase publish \
        --name users \
        --url http://localhost:4000/graphql \
        my/graph@main

Fetches a federated graph or a subgraph.

Usage:

grafbase schema [OPTIONS] <PROJECT_REF>

Arguments:

• <PROJECT_REF>: Project reference that uses the format account/graph@branch.

Options:

• --name <SUBGRAPH_NAME>: Subgraph name to fetch. If not provided, the entire graph schema is fetched.

List subgraphs in a graph.

Usage:

grafbase subgraphs <PROJECT_REF>

Arguments:

• <PROJECT_REF>: Project reference that uses the format account/graph@branch.

Submit a trusted documents manifest to the Gateway.

Usage:

grafbase trust --manifest <MANIFEST> --client-name <CLIENT_NAME> <PROJECT_REF>

Arguments:

• <PROJECT_REF>: Project reference that uses the format account/graph@branch.

Options:

• -m, --manifest <MANIFEST>: Path to the trusted documents manifest file.
• -c, --client-name <CLIENT_NAME>: Name of the client.