Skip to content

Commit ddfe478

Browse files
committed
Update README
1 parent 293860e commit ddfe478

File tree

1 file changed

+23
-44
lines changed

1 file changed

+23
-44
lines changed

README.md

Lines changed: 23 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
@apollosolutions/graphql-mock-cli
22
=================
3-
4-
Mock a GraphQL schema in one command
5-
6-
**The code in this repository is experimental and has been provided for reference purposes only. Community feedback is welcome but this project may not be supported in the same way that repositories in the official [Apollo GraphQL GitHub organization](https://github.com/apollographql) are. If you need help you can file an issue on this repository, [contact Apollo](https://www.apollographql.com/contact-sales) to talk to an expert, or create a ticket directly in Apollo Studio.**
7-
8-
93
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
104
[![Version](https://img.shields.io/npm/v/@apollosolutions/graphql-mock-cli.svg)](https://npmjs.org/package/@apollosolutions/graphql-mock-cli)
115
[![Downloads/week](https://img.shields.io/npm/dw/@apollosolutions/graphql-mock-cli.svg)](https://npmjs.org/package/@apollosolutions/graphql-mock-cli)
126

7+
Mock a GraphQL schema in one command
8+
9+
**The code in this repository is experimental and has been provided for reference purposes only. Community feedback is welcome but this project may not be supported in the same way that repositories in the official [Apollo GraphQL GitHub organization](https://github.com/apollographql) are. If you need help you can file an issue on this repository, [contact Apollo](https://www.apollographql.com/contact-sales) to talk to an expert, or create a ticket directly in Apollo Studio.**
1310

1411
<!-- toc -->
1512
* [Usage](#usage)
@@ -31,9 +28,8 @@ USAGE
3128
<!-- usagestop -->
3229
# Commands
3330
<!-- commands -->
34-
* [`graphql-mock-cli hello PERSON`](#graphql-mock-cli-hello-person)
35-
* [`graphql-mock-cli hello world`](#graphql-mock-cli-hello-world)
3631
* [`graphql-mock-cli help [COMMAND]`](#graphql-mock-cli-help-command)
32+
* [`graphql-mock-cli mock SCHEMA`](#graphql-mock-cli-mock-schema)
3733
* [`graphql-mock-cli plugins`](#graphql-mock-cli-plugins)
3834
* [`graphql-mock-cli plugins add PLUGIN`](#graphql-mock-cli-plugins-add-plugin)
3935
* [`graphql-mock-cli plugins:inspect PLUGIN...`](#graphql-mock-cli-pluginsinspect-plugin)
@@ -45,67 +41,50 @@ USAGE
4541
* [`graphql-mock-cli plugins unlink [PLUGIN]`](#graphql-mock-cli-plugins-unlink-plugin)
4642
* [`graphql-mock-cli plugins update`](#graphql-mock-cli-plugins-update)
4743

48-
## `graphql-mock-cli hello PERSON`
44+
## `graphql-mock-cli help [COMMAND]`
4945

50-
Say hello
46+
Display help for graphql-mock-cli.
5147

5248
```
5349
USAGE
54-
$ graphql-mock-cli hello PERSON -f <value>
50+
$ graphql-mock-cli help [COMMAND...] [-n]
5551
5652
ARGUMENTS
57-
PERSON Person to say hello to
53+
COMMAND... Command to show help for.
5854
5955
FLAGS
60-
-f, --from=<value> (required) Who is saying hello
61-
62-
DESCRIPTION
63-
Say hello
64-
65-
EXAMPLES
66-
$ graphql-mock-cli hello friend --from oclif
67-
hello friend from oclif! (./src/commands/hello/index.ts)
68-
```
69-
70-
_See code: [src/commands/hello/index.ts](https://github.com/apollosolutions/graphql-mock-cli/blob/v0.0.1/src/commands/hello/index.ts)_
71-
72-
## `graphql-mock-cli hello world`
73-
74-
Say hello world
75-
76-
```
77-
USAGE
78-
$ graphql-mock-cli hello world
56+
-n, --nested-commands Include all nested commands in the output.
7957
8058
DESCRIPTION
81-
Say hello world
82-
83-
EXAMPLES
84-
$ graphql-mock-cli hello world
85-
hello world! (./src/commands/hello/world.ts)
59+
Display help for graphql-mock-cli.
8660
```
8761

88-
_See code: [src/commands/hello/world.ts](https://github.com/apollosolutions/graphql-mock-cli/blob/v0.0.1/src/commands/hello/world.ts)_
62+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_
8963

90-
## `graphql-mock-cli help [COMMAND]`
64+
## `graphql-mock-cli mock SCHEMA`
9165

92-
Display help for graphql-mock-cli.
66+
Start a mock GraphQL server from a file
9367

9468
```
9569
USAGE
96-
$ graphql-mock-cli help [COMMAND...] [-n]
70+
$ graphql-mock-cli mock SCHEMA [--port <value>]
9771
9872
ARGUMENTS
99-
COMMAND... Command to show help for.
73+
SCHEMA Schema file to mock
10074
10175
FLAGS
102-
-n, --nested-commands Include all nested commands in the output.
76+
--port=<value> [default: 4000] HTTP port for server
10377
10478
DESCRIPTION
105-
Display help for graphql-mock-cli.
79+
Start a mock GraphQL server from a file
80+
81+
EXAMPLES
82+
$ graphql-mock-cli mock schema.graphql
83+
84+
$ graphql-mock-cli mock schema.graphql --port 8080
10685
```
10786

108-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_
87+
_See code: [src/commands/mock/index.ts](https://github.com/apollosolutions/graphql-mock-cli/blob/v0.0.1/src/commands/mock/index.ts)_
10988

11089
## `graphql-mock-cli plugins`
11190

0 commit comments

Comments
 (0)