# neo4j-graphql-cli > Deploy a Neo4j backed GraphQL API based on your GraphQL schema Latest version **0.0.11** (published 2017-08-29) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install neo4j-graphql-cli pnpm add neo4j-graphql-cli yarn add neo4j-graphql-cli bun add neo4j-graphql-cli ``` Provides the command `neo4j-graphql`. ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 0.0.11 | | Published | 2017-08-29 | | First published | 2017-05-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 4 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 61 | | Author | William Lyon | | Maintainers | neo4j-contrib | | Keywords | GraphQL, Neo4j | ## Links - npm: https://www.npmjs.com/package/neo4j-graphql-cli - Repository: https://github.com/neo4j-graphql/neo4j-graphql-cli - Homepage: https://github.com/neo4j-graphql/neo4j-graphql-cli#readme - Issues: https://github.com/neo4j-graphql/neo4j-graphql-cli/issues - npm.io page: https://npm.io/package/neo4j-graphql-cli ## Dependencies (4) - [opn](https://npm.io/package/opn.md) ^5.0.0 - [async](https://npm.io/package/async.md) ^2.4.0 - [chalk](https://npm.io/package/chalk.md) ^1.1.3 - [follow-redirects](https://npm.io/package/follow-redirects.md) ^1.2.3 ## Alternatives - [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads - [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads - [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads - [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads - [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads ## Recent versions - 0.0.11 (latest) — 2017-08-29 - 0.0.10 — 2017-08-24 - 0.0.9 — 2017-05-26 - 0.0.8 — 2017-05-21 - 0.0.7 — 2017-05-21 - 0.0.6 — 2017-05-21 - 0.0.5 — 2017-05-20 - 0.0.4 — 2017-05-20 - 0.0.3 — 2017-05-20 - 0.0.2 — 2017-05-20 - 0.0.1 — 2017-05-20 ## README # Neo4j GraphQL CLI Deploy Neo4j backed GraphQL APIs based on your custom GraphQL schema. **This is a very early project, under active development. Use for prototyping and demo projects only** ![](img/neo4j-graphql-cli.gif) **What does it do?** *`neo4j-graphql-cli` allows you to deploy a Neo4j GraphQL instance on Neo4j Sandbox. This Neo4j GraphQL instance will serve a GraphQL endpoint based on a user-defined GraphQL schema.* ## Steps 1. `npm install -g neo4j-graphql-cli` 1. Define your GraphQL schema using GraphQL schema syntax, *myschema.graphql* 1. `neo4j-graphql myschema.graphql` - if you do not specify a schema a [default movies schema]() will be used. 1. When prompted sign into Neo4j Sandbox using the URL provided. This URL will include a token to associate your `neo4j-graphql-cli` session with your sandbox instance. 1. Once your Neo4j GraphQL instance is deployed, you'll be presented with the credentials for your GraphQL instance, including a Graphiql URL. ## Schema First Development ### IDL / Schema Syntax ### Neo4j GraphQL Schema Neo4j GraphQL supports the basic schema syntax, with the addition of directives that expose the power of a graph database when combined with GraphQL: * `@cypher` **@cypher directive** The `@cypher` directive exposes the power of a full graph query language, Cypher, through GraphQL. ### Example movies schema ~~~graphql type User { id: Int name: String! movies: [Movie] @relation(name: "RATED", direction: "out") } type Movie { id: Int title: String! year: Int plot: String poster: String imdbRating: Float genres: [Genre] @relation(name: "IN_GENRE", direction: "out") actors: [Actor] @relation(name: "ACTED_IN", direction: "in") directors: [Director] @relation(name: "DIRECTED", direction: "in") similar: [Movie] @cypher(statement: "WITH {this} AS this MATCH (this)-[:IN_GENRE]->(:Genre)<-[:IN_GENRE]-(rec:Movie) WITH rec, COUNT(*) AS num ORDER BY num DESC RETURN rec LIMIT 10") } type Genre { id: Int name: String! movies: [Movie] @relation(name: "IN_GENRE", direction: "in") } type Director { id: Int name: String! movies: [Movie] @relation(name: "DIRECTED", direction: "out") } type Actor { id: Int name: String! movies: [Movie] @relation(name: "ACTED_IN", direction: "out") } ~~~ ## .graphqlconfig `neo4j-graphql-cli` supports [.graphqlconfig](https://github.com/graphcool/graphql-config) and will create a .graphqlconfig file that contains the path to the schema file, endpoints and authorization header. For example: ``` { "schemaPath":"personSchema.graphql", "extensions": { "endpoints": { "dev": { "url": "10-0-1-70-34285.neo4jsandbox.com/graphql/", "headers": { "Authorization":"Basic ${env:NEO4J_GRAPHQL_TOKEN}" } } } } } ``` # Features - [x] deploy Neo4j GraphQL Sandbox instance - [x] support user defined GraphQL schema - [x] support @cypher GraphQL schema directives - [x] .graphqlconfig support - [ ] support self-hosted Neo4j instances. NOTE: see - [ ] Docker support - [ ] support schema updates - [ ] client app scaffolding # Feedback This project is in active development and user validation. Have a use case you'd like to see supported? We'd love to hear your feedback, please email devrel@neo4j.com --- _Source: https://npm.io/package/neo4j-graphql-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._