https://github.com/sheerun/graphqlviz

GraphQL Server schema visualizer
https://github.com/sheerun/graphqlviz

cli graphql graphviz

Last synced: 5 days ago
JSON representation

GraphQL Server schema visualizer

• Host: GitHub
• URL: https://github.com/sheerun/graphqlviz
• Owner: sheerun
• License: mit
• Created: 2016-03-21T02:22:06.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-12T04:02:08.000Z (over 1 year ago)
• Last Synced: 2024-10-28T12:12:47.995Z (6 days ago)
• Topics: cli, graphql, graphviz
• Language: JavaScript
• Homepage:
• Size: 1.56 MB
• Stars: 732
• Watchers: 15
• Forks: 56
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-graphql - graphqlviz - GraphQL API visualizer in Node.js (Tools / Julia Libraries)
• awesome-ccamel - sheerun/graphqlviz - GraphQL Server schema visualizer (JavaScript)
• awesome-starred - sheerun/graphqlviz - GraphQL Server schema visualizer (graphql)
• awesome-graphql - graphqlviz - GraphQL API visualizer in Node.js (Tools / Crystal Libraries)

README

        
# graphqlviz [![Build Status](https://travis-ci.org/sheerun/graphqlviz.svg?branch=master)](https://travis-ci.org/sheerun/graphqlviz)

> GraphQL Server CLI visualizer. Adapted from original [web interface](https://github.com/NathanRSmith/graphql-visualizer).

![](demo.gif)

## CLI

```

$ npm install -g graphqlviz

```

```

GraphQL Server CLI visualizer

Options:

  -t, --theme      path to theme overrides

  --print-theme    prints default theme to stdout

  --verbose        print introspection result

  -a --auth       set Authorization header for graphql server

Usage

  $ graphqlviz [url]

      Renders dot schema from [url] endpoint

Examples

  $ graphqlviz https://localhost:3000 | dot -Tpng -o graph.png

  $ graphqlviz https://localhost:3000 -a "Bearer xxxxx" | dot -Tpng -o graph.png

  $ graphqlviz https://swapi.apis.guru | dot -Tpng | open -f -a Preview

  $ graphqlviz path/to/schema.json | dot -Tpng | open -f -a Preview

  $ graphqlviz path/to/schema.graphql | dot -Tpng | open -f -a Preview

  $ graphqlviz --print-theme > theme.json

  $ graphqlviz https://localhost:3000 -t theme.json | dot -Tpng | open -f -a Preview

  $ graphqlviz schema.json --theme.header.invert=true | dot -Tpng > schema.png

```

Note that `dot` is `graphviz`'s tool to produce layered drawings of directed graphs. `graphviz` is available through most package managers including homebrew and apt-get. Details here: https://www.graphviz.org/download/

## Customizing output

You can print default theme with `graphqlviz --print-theme > theme.json`, then you can modify it, and pass with `--theme theme.json` argument. All the available colors can be found on the [graphviz site](http://www.graphviz.org/doc/info/colors.html). 

## Windows Users

Windows users looking use the `dot` command should download & install from the [graphviz website](https://graphviz.gitlab.io/_pages/Download/Download_windows.html) and ensure the installation location is on the system `PATH`. It has been reported that, for at least some windows versions, the `msi` does not automatically add the installation to the `PATH`. Alternatively the executables can be invoked directly. The installation location will likely be similar to `C:\Program Files (x86)\Graphviz2.38\bin\`.

## Mac Users

Mac users can install the `dot` command as part of [graphviz](https://www.graphviz.org) (from AT&T and Bell Labs) by running:

```

brew install graphviz

```

## Team

[![Adam Stankiewicz](https://avatars3.githubusercontent.com/u/292365?s=130)](https://sheerun.net) | [![Nathan Smith](https://avatars1.githubusercontent.com/u/1530197?s=130)](http://nathanrandal.com/) | [![Join](https://s28.postimg.org/hcy7aq9nh/42.png)](https://github.com/sheerun/graphqlviz/pulls)

---|---|---

[Adam Stankiewicz](https://sheerun.net) | [Nathan Smith](http://nathanrandal.com/) | [Join](https://github.com/sheerun/graphqlviz/pulls)