Skip to content

Latest commit

 

History

History

cli

README.md

Stitch CLI

Resources

Commands like apply:resources expect resources in YAML files in a specific format:

kind: Schema
metadata:
  name: usersApi
  namespace: users
schema: |
  type Query {
      getUser(id: ID!): String
          @rest(url: "http://users-service/users/{args.id}")
  }

Or the schema resource can include file patterns of gql files.

kind: Schema
metadata:
  name: usersApi
  namespace: users
schemaFiles:
  - ./**/*.gql

Or both schema and schemaFiles properties can be defined. In this case schema property value will be considered as content of additional file.

kind: Upstream
metadata:
  name: usersApi
  namespace: users
host: 'users-service'
auth:
  type: ActiveDirectory
  activeDirectory:
    authority: https://login.microsoftonline.com/<TENANT_ID>
    resource: http://user-service-ad-resource
kind: UpstreamClientCredentials
metadata:
  name: activedirectoryTenant
  namespace: users
authType: ActiveDirectory
activeDirectory:
  authority: https://login.microsoftonline.com/<TENANT_ID>
  clientId: myAdClientId
  clientSecret: myAdClientSecret
kind: Policy
metadata:
  name: usersPolicy
  namespace: users
type: opa
code: |
  default allow = false
  allow {
      input.args.role == "admin"
  }
args:
  role: String

Commands

stitch apply:base-policy RESOURCEPATH

Apply base policy

USAGE
  $ stitch apply:base-policy RESOURCEPATH

OPTIONS
  --authorization-header=authorization-header  Custom authorization header
  --dry-run                                    Should perform a dry run
  --registry-url=registry-url                  (required) Url of the registry
  --timeout=timeout                            [default: 10000] Request timeout

EXAMPLE

         $ stitch apply:base-policy base-policy.yaml
         Uploaded successfully!

See code: src/commands/apply/base-policy.ts

stitch apply:introspection-query-policy RESOURCEPATH

Apply introspection query policy

USAGE
  $ stitch apply:introspection-query-policy RESOURCEPATH

OPTIONS
  --authorization-header=authorization-header  Custom authorization header
  --dry-run                                    Should perform a dry run
  --registry-url=registry-url                  (required) Url of the registry
  --timeout=timeout                            [default: 10000] Request timeout

EXAMPLE

         $ stitch apply:introspection-query-policy introspection-query-policy.yaml
         Uploaded successfully!

See code: src/commands/apply/introspection-query-policy.ts

stitch apply:resources RESOURCESPATH

Apply resources

USAGE
  $ stitch apply:resources RESOURCESPATH

OPTIONS
  --authorization-header=authorization-header  Custom authorization header
  --dry-run                                    Should perform a dry run
  --registry-url=registry-url                  (required) Url of the registry
  --skip-resource-types=skip-resource-types    Resource types to skip
  --timeout=timeout                            [default: 10000] Request timeout
  --verbose                                    Verbose mode

EXAMPLE
  $ stitch apply:resources schema.gql
  Uploaded successfully!

See code: src/commands/apply/resources.ts

stitch help [COMMAND]

display help for stitch

USAGE
  $ stitch help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

stitch refresh:remote-schema REMOTESERVERURL

Refresh remote schema

USAGE
  $ stitch refresh:remote-schema REMOTESERVERURL

OPTIONS
  --authorization-header=authorization-header  Custom authorization header
  --registry-url=registry-url                  (required) Url of the registry
  --timeout=timeout                            [default: 10000] Request timeout
  --verbose                                    Verbose mode

EXAMPLE
  $ stitch refresh:remote-schema http://remote-graphql-server/graphql
  Remote schema refreshed successfully!

See code: src/commands/refresh/remote-schema.ts