Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #2

Merged
merged 2 commits into from
Nov 12, 2024
Merged

Update README #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddfe478
Update README
smyrick Nov 12, 2024
d3694bc
Update actions
smyrick Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/onPushToMain.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ jobs:
- name: Setup git
if: ${{ steps.version-check.outputs.skipped == 'false' }}
run: |
git config --global user.email ${{ secrets.GH_EMAIL }}
git config --global user.name ${{ secrets.GH_USERNAME }}
git config --global user.name "${{ github.actor }}"
git config --global user.email "${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com"
- name: Generate oclif README
if: ${{ steps.version-check.outputs.skipped == 'false' }}
id: oclif-readme
Expand Down
67 changes: 23 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
@apollosolutions/graphql-mock-cli
=================

Mock a GraphQL schema in one command

**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.**


[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@apollosolutions/graphql-mock-cli.svg)](https://npmjs.org/package/@apollosolutions/graphql-mock-cli)
[![Downloads/week](https://img.shields.io/npm/dw/@apollosolutions/graphql-mock-cli.svg)](https://npmjs.org/package/@apollosolutions/graphql-mock-cli)

Mock a GraphQL schema in one command

**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.**

<!-- toc -->
* [Usage](#usage)
Expand All @@ -31,9 +28,8 @@ USAGE
<!-- usagestop -->
# Commands
<!-- commands -->
* [`graphql-mock-cli hello PERSON`](#graphql-mock-cli-hello-person)
* [`graphql-mock-cli hello world`](#graphql-mock-cli-hello-world)
* [`graphql-mock-cli help [COMMAND]`](#graphql-mock-cli-help-command)
* [`graphql-mock-cli mock SCHEMA`](#graphql-mock-cli-mock-schema)
* [`graphql-mock-cli plugins`](#graphql-mock-cli-plugins)
* [`graphql-mock-cli plugins add PLUGIN`](#graphql-mock-cli-plugins-add-plugin)
* [`graphql-mock-cli plugins:inspect PLUGIN...`](#graphql-mock-cli-pluginsinspect-plugin)
Expand All @@ -45,67 +41,50 @@ USAGE
* [`graphql-mock-cli plugins unlink [PLUGIN]`](#graphql-mock-cli-plugins-unlink-plugin)
* [`graphql-mock-cli plugins update`](#graphql-mock-cli-plugins-update)

## `graphql-mock-cli hello PERSON`
## `graphql-mock-cli help [COMMAND]`

Say hello
Display help for graphql-mock-cli.

```
USAGE
$ graphql-mock-cli hello PERSON -f <value>
$ graphql-mock-cli help [COMMAND...] [-n]

ARGUMENTS
PERSON Person to say hello to
COMMAND... Command to show help for.

FLAGS
-f, --from=<value> (required) Who is saying hello

DESCRIPTION
Say hello

EXAMPLES
$ graphql-mock-cli hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
```

_See code: [src/commands/hello/index.ts](https://github.com/apollosolutions/graphql-mock-cli/blob/v0.0.1/src/commands/hello/index.ts)_

## `graphql-mock-cli hello world`

Say hello world

```
USAGE
$ graphql-mock-cli hello world
-n, --nested-commands Include all nested commands in the output.

DESCRIPTION
Say hello world

EXAMPLES
$ graphql-mock-cli hello world
hello world! (./src/commands/hello/world.ts)
Display help for graphql-mock-cli.
```

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

## `graphql-mock-cli help [COMMAND]`
## `graphql-mock-cli mock SCHEMA`

Display help for graphql-mock-cli.
Start a mock GraphQL server from a file

```
USAGE
$ graphql-mock-cli help [COMMAND...] [-n]
$ graphql-mock-cli mock SCHEMA [--port <value>]

ARGUMENTS
COMMAND... Command to show help for.
SCHEMA Schema file to mock

FLAGS
-n, --nested-commands Include all nested commands in the output.
--port=<value> [default: 4000] HTTP port for server

DESCRIPTION
Display help for graphql-mock-cli.
Start a mock GraphQL server from a file

EXAMPLES
$ graphql-mock-cli mock schema.graphql

$ graphql-mock-cli mock schema.graphql --port 8080
```

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

## `graphql-mock-cli plugins`

Expand Down