Skip to content

Latest commit

 

History

History
168 lines (112 loc) · 4.44 KB

graph.md

File metadata and controls

168 lines (112 loc) · 4.44 KB
Raw
title description
Netlify CLI graph command
Sync and edit your Netlify Graph library

graph

(Beta) Control the Netlify Graph functions for the current site

Usage

netlify graph

Flags

  • debug (boolean) - Print debugging information
  • httpProxy (string) - Proxy server address to route requests through.
  • httpProxyCertificateFilename (string) - Certificate file to use when connecting using a proxy server
Subcommand description
graph:config:write Write a .graphqlrc.json file to the current directory for use with local tooling (e.g. the graphql extension for vscode)
graph:edit Launch the browser to edit your local graph functions from Netlify
graph:handler Generate a handler for a Graph operation given its name. See graph:operations for a list of operations.
graph:init Initialize all the resources for Netlify Graph
graph:library Generate the Graph function library
graph:operations List all of the locally available operations
graph:pull Pull your remote Netlify Graph schema locally, and process pending Graph edit events

Examples

netlify graph:pull
netlify graph:edit

graph:config:write

Write a .graphqlrc.json file to the current directory for use with local tooling (e.g. the graphql extension for vscode)

Usage

netlify graph:config:write

Flags

  • debug (boolean) - Print debugging information
  • httpProxy (string) - Proxy server address to route requests through.
  • httpProxyCertificateFilename (string) - Certificate file to use when connecting using a proxy server

graph:edit

Launch the browser to edit your local graph functions from Netlify

Usage

netlify graph:edit

Flags

  • debug (boolean) - Print debugging information
  • httpProxy (string) - Proxy server address to route requests through.
  • httpProxyCertificateFilename (string) - Certificate file to use when connecting using a proxy server

graph:handler

Generate a handler for a Graph operation given its name. See graph:operations for a list of operations.

Usage

netlify graph:handler

Arguments

  • name - Operation name(s)

Flags

  • codegen (string) - The id of the specific code generator to use
  • data (string) - Optional data to pass along to the code generator
  • debug (boolean) - Print debugging information
  • httpProxy (string) - Proxy server address to route requests through.
  • httpProxyCertificateFilename (string) - Certificate file to use when connecting using a proxy server

graph:init

Initialize all the resources for Netlify Graph

Usage

netlify graph:init

Flags

  • debug (boolean) - Print debugging information
  • httpProxy (string) - Proxy server address to route requests through.
  • httpProxyCertificateFilename (string) - Certificate file to use when connecting using a proxy server

graph:library

Generate the Graph function library

Usage

netlify graph:library

Flags

  • debug (boolean) - Print debugging information
  • httpProxy (string) - Proxy server address to route requests through.
  • httpProxyCertificateFilename (string) - Certificate file to use when connecting using a proxy server

graph:operations

List all of the locally available operations

Usage

netlify graph:operations

Flags

  • debug (boolean) - Print debugging information
  • httpProxy (string) - Proxy server address to route requests through.
  • httpProxyCertificateFilename (string) - Certificate file to use when connecting using a proxy server

graph:pull

Pull your remote Netlify Graph schema locally, and process pending Graph edit events

Usage

netlify graph:pull

Flags

  • debug (boolean) - Print debugging information
  • httpProxy (string) - Proxy server address to route requests through.
  • httpProxyCertificateFilename (string) - Certificate file to use when connecting using a proxy server