|
1 | 1 | > Once you head down the GraphQL's path
|
2 | 2 | > forever will it dominate your destiny.
|
3 | 3 |
|
| 4 | +[](https://github.com/graphql-editor/graphql-editor-cli) |
| 5 | +[](https://github.com/graphql-editor/graphql-editor-cli/issues) |
| 6 | +[](https://www.npmjs.com/package/gei-bookings) |
| 7 | +[](https://github.com/graphql-editor/graphql-editor-integrations/actions?query=branch%3Amaster) |
| 8 | +[](https://github.com/graphql-editor/graphql-editor-cli/pulls) |
| 9 | + |
4 | 10 | # GraphQL Editor Cli
|
5 | 11 |
|
6 |
| -Compatible with [GraphQL Editor](https://graphqleditor.com) projects( Free and Paid Tiers). The main goal is to provide interactive experience creating GraphQL as a service. |
| 12 | +> Compatible with [GraphQL Editor](https://graphqleditor.com) our CLI works seamlessly with your projects on both the free and paid plans. Its main goal is to enhance your interactive experience and provide tools for working with GraphQL as a service. |
7 | 13 |
|
8 | 14 | ## Requirements
|
9 | 15 |
|
10 | 16 | - [GraphQL Editor](https://graphqleditor.com)
|
11 | 17 | - NodeJS >= 16
|
12 | 18 |
|
13 |
| -- [GraphQL Editor Cli](#graphql-editor-cli) |
14 |
| - - [Requirements](#requirements) |
15 |
| - - [Installation](#installation) |
16 |
| - - [Global](#global) |
17 |
| - - [Inside Repo](#inside-repo) |
18 |
| - - [Docs](#docs) |
| 19 | +## Installation :zap: |
| 20 | + |
| 21 | +Let's go over the installation process step by step. |
19 | 22 |
|
20 |
| -## Installation |
| 23 | +### Global :earth_africa: |
21 | 24 |
|
22 |
| -### Global |
| 25 | +First to install globally use the following command: |
23 | 26 |
|
24 | 27 | ```sh
|
25 | 28 | npm i -g graphql-editor-cli
|
26 | 29 | ```
|
27 | 30 |
|
28 |
| -### Inside Repo |
| 31 | +### Inside Repo :house: |
| 32 | + |
| 33 | +then install it in your repository using this one: |
29 | 34 |
|
30 | 35 | ```sh
|
31 | 36 | npm i -D graphql-editor-cli
|
32 | 37 | ```
|
33 | 38 |
|
34 |
| -then use with npx for example or as a `package.json` script. |
| 39 | +That's it! Now you can use it freely, for example with npx or as a `package.json` script. |
| 40 | + |
| 41 | +## Author |
| 42 | + |
| 43 | +👤 **Artur Czemiel** |
| 44 | + |
| 45 | +- Website: https://graphqleditor.com |
| 46 | +- Github: [@Aexol](https://github.com/aexol) |
| 47 | + |
| 48 | +## 🤝 Contributing |
| 49 | + |
| 50 | +Contributions, issues and feature requests are welcome! |
| 51 | + |
| 52 | +Feel free to check our [issues page](https://github.com/graphql-editor/graphql-editor-cli/issues). |
| 53 | + |
| 54 | +## :scroll: Docs |
| 55 | + |
| 56 | +If you want to know more our docs are available here: |
| 57 | +[GraphQL editor docs](https://graphqleditor.com/docs/tools/graphql-cli/) |
| 58 | + |
| 59 | +## 📝 License |
35 | 60 |
|
36 |
| -## Docs |
| 61 | +Copyright © 2023 [GraphQL Editor](https://github.com/graphql-editor). |
37 | 62 |
|
38 |
| -Docs are available here: |
39 |
| -[https://graphqleditor.com/docs/tools/untitled/README/](https://graphqleditor.com/docs/tools/untitled/README/) |
| 63 | +This project is [MIT](https://github.com/graphql-editor/graphql-editor-integrations/blob/master/LICENSE) licensed. |
0 commit comments