WunderGraph Cosmo

https://github.com/wundergraph/cosmo-docs
Admin
WunderGraph Cosmo is a unified API platform for building and managing applications by connecting...
Tokens:356,664
Snippets:3,416
Trust Score:9.6
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Example: npx wgc monograph version get mygraph -n prod

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/monograph/version/get.mdx

Example command and its output, displaying the router compatibility version in a table.

```bash
> npx wgc monograph version get mygraph -n prod
┌────────────┬───────────┬─────────┐
│ GRAPH NAME │ NAMESPACE │ VERSION │
├────────────┼───────────┼─────────┤
│ mygraph    │ prod      │ 1       │
└────────────┴───────────┴─────────┘
```

--------------------------------

### Start the subgraphs

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/tutorial/from-zero-to-federation-in-5-steps-using-cosmo.mdx

Installs dependencies and starts the subgraphs in the background. The script must remain running for the tutorial.

```bash
./start-subgraphs.sh
```

--------------------------------

### main.go: Initialize HTTP client and register service

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/snippets/go-tutorial.mdx

Starting point for the main.go file after removing the example schema's resolver remnants. Initializes an HTTP client with base URL, timeout, and header, registers the StarwarsService with the gRPC server, and defines the service struct with a persistent client field. The QueryPeople resolver currently panics and must be implemented.

```go
package main

import (
	"context"
	"log"
	"net/http"
	"time"

	service "github.com/wundergraph/cosmo/plugin/generated"
	"github.com/wundergraph/cosmo/router-plugin/httpclient"

	routerplugin "github.com/wundergraph/cosmo/router-plugin"
	"google.golang.org/grpc"
)

func main() {
	// 1. Initialize the HTTP client
	client := httpclient.New(
		httpclient.WithBaseURL("https://swapi.info/api/"),
		httpclient.WithTimeout(30*time.Second),
		httpclient.WithHeader("Accept", "application/json"),
	)

	// 2. Add the new HTTP client to the service
	pl, err := routerplugin.NewRouterPlugin(func(s *grpc.Server) {
		s.RegisterService(&service.StarwarsService_ServiceDesc, &StarwarsService{
			client: client,
		})
	})

	if err != nil {
		log.Fatalf("failed to create router plugin: %v", err)
	}

	pl.Serve()
}

// 3. Add a new *httpclient.Client field to be used by the service.
type StarwarsService struct {
	service.UnimplementedStarwarsServiceServer
	client *httpclient.Client
}

func (s *StarwarsService) QueryPeople(ctx context.Context, req *service.QueryPeopleRequest) (*service.QueryPeopleResponse, error) {
	panic("not implemented")
}
```

--------------------------------

### Example: get version for mygraph in prod namespace

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/federated-graph/version/get.mdx

Example command and its output. The command retrieves the version for graph 'mygraph' in namespace 'prod'. The output shows a table with the graph name, namespace, and version (1).

```bash
> npx wgc federated-graph version get mygraph -n prod
┌────────────┬───────────┬─────────┐
│ GRAPH NAME │ NAMESPACE │ VERSION │
├────────────┼───────────┼─────────┤
│ mygraph    │ prod      │ 1       │
└────────────┴───────────┴─────────┘
```

--------------------------------

### Typical workflow for creating a router plugin

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/gRPC/plugins.mdx

A bash script that initializes a full router project with a plugin, builds and starts the router, and guides the user through customizing the schema and implementation. It uses the `wgc router plugin init` command and the `make` command to build and run the project.

```bash
# 1️⃣ Initialize a full router project with a plugin
wgc router plugin init hello-world -p myproject --language go

# 2️⃣ Go to the project directory "myproject"
cd myproject

# 3️⃣ Build, compose and start the router. Navigate to http://localhost:3010
make

# 4️⃣ Customize the schema and implementation to your needs
# Edit `./plugins/hello-world/src/schema.graphql`

# 5️⃣ Generate the code for your plugin to implement the resolvers
cd plugins/hello-world && make generate

# 6️⃣ Now you can implement your gRPC resolvers in `./plugins/hello-world/src/main.go` (for Go) or `./plugins/hello-world/src/plugin.ts` (for TypeScript)

# ⭐ Regenerate the code, build the plugin and serve the latest config.
# Navigate to http://localhost:3010 again to query your supergraph
make
```

--------------------------------

### Install Mintlify CLI

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/README.md

Install the Mintlify CLI globally using pnpm to preview documentation changes locally.

```bash
pnpm add -g mintlify
```

--------------------------------

### Initialize project and install dependencies (NPM, Yarn, PNPM)

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/studio/sce/handler-example.mdx

Initializes the project and installs fastify and tsx as dev dependencies using the preferred package manager.

```shell
npm init -y
npm install --save-dev fastify tsx
```

```shell
yarn init -y
yarn add --dev fastify tsx
```

```shell
pnpm init
pnpm add --save-dev fastify
```

--------------------------------

### Example directory structure

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/query-plan/batch-generate-query-plans.mdx

Assumed directory structure for the query plan generation example: operations folder, execution config, and plans output folder.

```bash
./operations/query1.graphql
./operations/query2.graphql
./execution-config.json
./plans
```

--------------------------------

### Example: Create namespace 'production'

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/namespace/create.mdx

Creates a new namespace named 'production'. Namespaces must be created before they can be used, for example before adding a graph to it.

```bash
npx wgc namespace create production
```

--------------------------------

### Install Go and OpenAPI generator plugins

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/connect-rpc/produce-generate-distribute-sdks.mdx

Installs the Buf generator plugins for Go and OpenAPI using the Go toolchain. Ensure $(go env GOPATH)/bin is in your $PATH so the installed binaries are accessible.

```bash
# Ensure $(go env GOPATH)/bin is in your $PATH
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest
go install github.com/sudorandom/protoc-gen-connect-openapi/cmd/protoc-gen-connect-openapi@latest
```

--------------------------------

### Install and authenticate the Cosmo CLI

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/getting-started/cosmo-cloud-onboarding.mdx

Install the Cosmo CLI globally, log in to your Cosmo account, and verify your session and organization.

```bash
npm install -g wgc@latest
```

```bash
wgc auth login
```

```bash
wgc auth whoami
```

--------------------------------

### Example output of list command

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/router/compatibility-version/list.mdx

Example output showing the table of router compatibility versions currently supported by WunderGraph Cosmo Cloud.

```bash
> npx wgc router compatibility-version list
The router compatibility versions currently supported are:
┌─────────┬───┐
│ VERSION │ 1 │
└─────────┴───┘
```

--------------------------------

### Example output of setting router compatibility version

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/monograph/version/set.mdx

Example output of the command. It shows the success message and a table with the graph name, namespace, previous version, and new version.

```bash
> npx wgc federated-graph version set mygraph -v 1
✔ Successfully set the router compatibility version for federated graph "prod" to 1.
┌────────────┬───────────┬──────────────────┬─────────────┐
│ GRAPH NAME │ NAMESPACE │ PREVIOUS VERSION │ NEW VERSION │
├────────────┼───────────┼──────────────────┼─────────────┤
│ prod       │ default   │ 2                │ 1           │
└────────────┴───────────┴──────────────────┴─────────────┘
```

--------------------------------

### Example YAML Configuration for Circuit Breaker

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/traffic-shaping/circuit-breaker.mdx

Complete YAML example showing global and subgraph-specific circuit breaker settings with inline comments for each option.

```yaml
traffic_shaping:
  all:
    circuit_breaker:
      enabled: true
      request_threshold: 20           # Need 20+ requests before evaluating
      error_threshold_percentage: 50  # Open circuit at 50% error rate
      sleep_window: 30s               # Block requests for 30 seconds
      half_open_attempts: 5           # Allow 5 test requests
      required_successful: 3          # Need 3 successes to close circuit
      rolling_duration: 60s           # 60-second evaluation window
      num_buckets: 10                 # 10 buckets = 6 seconds per bucket
      execution_timeout: 60s          # Max time before marking as error
  subgraphs:
    employees:
      circuit_breaker:
        enabled: false  # Disable for this specific subgraph
    products:
      circuit_breaker:
        enabled: true
        request_threshold: 30         # Override global setting
```

--------------------------------

### Install TypeScript SDK

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/connect-rpc/consume-via-sdks.mdx

Installs the generated TypeScript SDK package and the required Connect runtime libraries. Replace @my-org/sdk with the actual package name provided by your platform team.

```bash
npm install @my-org/sdk @connectrpc/connect @connectrpc/connect-web
```

--------------------------------

### Example YAML config (old authentication)

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/configuration.mdx

Example YAML configuration for the old authentication config (Router Version < 0.XXX.X), showing a provider with a JWKS URL and optional header settings.

```yaml
version: "1"

# Authentication and Authorization
# See https://cosmo-docs.wundergraph.com/router/authentication-and-authorization for more information
authentication:
  providers:
    - name: My Auth Provider # Optional, used for error messages and diagnostics
      jwks: # JWKS provider configuration
        url: https://example.com/.well-known/jwks.json # URL to load the JWKS from
        header_name: Authorization # Optional
        header_value_prefix: Bearer # Optional
```

--------------------------------

### Example YAML config V2

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/configuration.mdx

Example YAML configuration for the V2 authentication settings, showing multiple JWKS providers with optional algorithms and refresh_unknown_kid settings, plus header sources.

```yaml
authentication:
  jwt:
    jwks:
      - url: "https://example.com/.well-known/jwks.json"
        refresh_interval: 1m
        # Leaving algorithms empty will allow all supported algorithms from the config docs
        refresh_unknown_kid:
          enabled: true
          max_wait: 2m
          interval: 30s
          burst: 2
      - url: "https://example2.com/.well-known/jwks.json"
        refresh_interval: 2m
        # optional list of allowed algorithms per JWKS
        algorithms: ["RS256", "EdDSA", "HS512"]
        refresh_unknown_kid:
          enabled: false # These are defaults
          max_wait: 2m 
          interval: 30s
          burst: 2
    header_name: Authorization # This is the default value
    header_value_prefix: Bearer # This is the default value
    header_sources:
      - type: header
        name: X-Auth-Token
        value_prefixes: [Token, MyToken]
      - type: header
        name: X-Authorization
```

--------------------------------

### Install Go SDK

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/connect-rpc/consume-via-sdks.mdx

Downloads the generated Go SDK module. Replace github.com/my-org/sdk with the actual module path provided by your platform team.

```bash
go get github.com/my-org/sdk
```

--------------------------------

### Create a new trace with otel.Tracer

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/gRPC/plugins/go-plugin/telemetry.mdx

This example shows how to create a new span for a query operation. It uses the OpenTelemetry tracer to start a span, adds attributes, and returns the response. The comment notes that derived tracers need to be passed down where needed.

```go
func (p *ProjectsService) QueryProjectsByStatus(ctx context.Context, req *service.QueryProjectsByStatusRequest) (*service.QueryProjectsByStatusResponse, error) {
	// Create a tracer from the inner global tracer
	tracer := otel.Tracer("projects-service")
	ctx, span := tracer.Start(ctx, "Query Projects By Status")
	defer span.End()

	// Add attributes to the span
	span.SetAttributes(
		attribute.Key("project.status`").Int(req.Status)
	)

	// Note that if you want to create a tracer derived from
	// the above tracer, you will need to pass it down to where its needed
	projects := getProjectsForStatus(ctx, req.Status)

	return &service.QueryProjectsByStatusResponse{ProjectsByStatus: projects}, nil
}
```

--------------------------------

### Configure plugin logging with WithLogger and WithCustomLogger

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/gRPC/plugins/go-plugin/logging.mdx

Two Go examples for configuring logging in a Cosmo router plugin. The first uses `routerplugin.WithLogger(hclog.Info)` for standard JSON logging at Info level. The second creates a custom `hclog` logger with `JSONFormat: true` and passes it via `routerplugin.WithCustomLogger(customLogger)`. Both register a gRPC service and start the plugin with `pl.Serve()`.

```go
package main

import (
    "github.com/hashicorp/go-hclog"
    "github.com/wundergraph/cosmo/router/pkg/routerplugin"
)

func main() {
    registerFunc := func(s *grpc.Server) {
		s.RegisterService(&projects.ProjectsService_ServiceDesc, &service.ProjectsService{
			NextID: 1,
		})
	}

    // Create plugin with JSON logging at Info level
    pl, err := routerplugin.NewRouterPlugin(registerFunc,
        routerplugin.WithLogger(hclog.Info),
    )
    if err != nil {
        panic(err)
    }
    
    // Start the plugin
    pl.Serve()
}
```

```go
package main

import (
    "github.com/hashicorp/go-hclog"
    "github.com/wundergraph/cosmo/router/pkg/routerplugin"
)

func main() {
  	registerFunc := func(s *grpc.Server) {
		s.RegisterService(&projects.ProjectsService_ServiceDesc, &service.ProjectsService{
			NextID: 1,
		})
	}

    // Create custom JSON logger
    customLogger := hclog.New(&hclog.LoggerOptions{
        Name:            "my-plugin", 
        Level:           hclog.Info,
        IncludeLocation: true,
        DisableTime:     false, // JSON logs can include timestamps
        JSONFormat:      true,  // JSON format for structured logging
    })

    // Create plugin with custom logger
    pl, err := routerplugin.NewRouterPlugin(registerFunc,
        routerplugin.WithCustomLogger(customLogger),
    )
    if err != nil {
        panic(err)
    }
    
    // Start the plugin
    pl.Serve()
}
```

--------------------------------

### Generated plan files

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/query-plan/batch-generate-query-plans.mdx

For the given example, the output will generate two files: `plans/query1.graphql` and `plans/query2.graphql`.

```bash
plans/query1.graphql
plans/query2.graphql
```

--------------------------------

### Install or upgrade the router Helm chart

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/deployments-and-hosting/kubernetes/helm-chart/router.mdx

Use helm upgrade --install to install or upgrade the router release with the specified version and values file.

```bash
helm upgrade --install router oci://ghcr.io/wundergraph/cosmo/helm-charts/router \
    --version 0.0.1 \
    --values ./values.yaml
```

--------------------------------

### Initialize Go gRPC service with wgc grpc-service init

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/tutorial/grpc-service-quickstart.mdx

Initializes a Go gRPC service using the Connect RPC template, then changes into the created directory.

```bash
wgc grpc-service init --template golang-connect-rpc --directory ./my-grpc-service
cd my-grpc-service
```

--------------------------------

### WithCustomLogger option for custom logging

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/gRPC/plugins/go-plugin/logging.mdx

Use this option for advanced logging setups where you need full control. It accepts any implementation of the hclog.Logger interface, allowing custom configurations, wrappers, or adapters. When using a non-JSON format, timestamps must be disabled because the go-plugin framework parses log lines by checking if they start with the log level (e.g., [TRACE], [INFO]); otherwise the framework defaults to debug level.

```go
func WithCustomLogger(logger hclog.Logger)
```

--------------------------------

### Skip tool installation

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/router/plugin/generate.mdx

Skips tool installation, useful in CI environments.

```bash
wgc router plugin generate --skip-tools-installation ./my-plugin
```

--------------------------------

### GET /employees.v1.HrService/GetEmployees

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/connect-rpc/consume-via-rest-openapi.mdx

Retrieve all employees using an HTTP GET request with query parameters.

```APIDOC
## [GET] /employees.v1.HrService/GetEmployees

### Description
Retrieve all employees. This is a read-only query operation that can be called via HTTP GET for caching benefits.

### Method
GET

### Endpoint
http://localhost:5026/employees.v1.HrService/GetEmployees

### Parameters
#### Query Parameters
- **connect** (string) - Required - Must be set to `v1` to specify the protocol version.
- **encoding** (string) - Required - Must be set to `json` to specify the format of the message data.
- **message** (string) - Required - A URL-encoded JSON object containing the arguments. For this query, use an empty object `{}`.

### Request Example
curl --get \
  --data-urlencode 'encoding=json' \
  --data-urlencode 'message={}' \
  --data-urlencode 'connect=v1' \
  http://localhost:5026/employees.v1.HrService/GetEmployees

### Response
#### Success Response (200)
- **employees** (array) - List of employee objects.

#### Response Example
{
  "employees": []
}
```

--------------------------------

### Create and publish the products subgraph

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/getting-started/cosmo-cloud-onboarding.mdx

Creates the 'products' subgraph in the 'development' namespace, then downloads its schema and publishes it. This is the first subgraph in the demo setup.

```bash
wgc subgraph create products \
    --namespace development \
    --routing-url https://product-api.fly.dev/graphql
```

```bash
curl -O https://raw.githubusercontent.com/wundergraph/cosmo/refs/heads/main/demo/pkg/subgraphs/products/subgraph/schema.graphqls \
&& wgc subgraph publish products \
    --namespace development \
    --schema ./schema.graphqls
```

--------------------------------

### GET /employees.v1.HrService/GetEmployeeById

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/connect-rpc/consume-via-rest-openapi.mdx

Retrieve an employee by ID using an HTTP GET request with query parameters.

```APIDOC
## [GET] /employees.v1.HrService/GetEmployeeById

### Description
Retrieve an employee by ID using an HTTP GET request. This is a read-only query operation that can be cached.

### Method
GET

### Endpoint
http://localhost:5026/employees.v1.HrService/GetEmployeeById

### Parameters
#### Query Parameters
- **connect** (string) - Required - Must be set to `v1` to specify the protocol version.
- **encoding** (string) - Required - Must be set to `json` to specify the format of the message data.
- **message** (string) - Required - A URL-encoded JSON object containing the arguments, e.g., `{"id": 1}`.

### Request Example
curl --get \
  --data-urlencode 'encoding=json' \
  --data-urlencode 'message={"id": 1}' \
  --data-urlencode 'connect=v1' \
  http://localhost:5026/employees.v1.HrService/GetEmployeeById

### Response
#### Success Response (200)
- **employee** (object) - The employee data.

#### Response Example
{
  "employee": {}
}
```

--------------------------------

### Verify Docker Buildx Setup

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/router/plugin/publish.mdx

Run these commands to verify Docker Buildx is enabled and a container builder is configured. The output of `docker buildx inspect` must show the `docker-container` driver.

```bash
docker buildx version
docker buildx inspect
```

--------------------------------

### Initialize gRPC plugin with wgc router plugin init

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/tutorial/using-grpc-plugins.mdx

Initialize a new gRPC plugin named 'starwars'. Replace <preferredLang> with 'go' for Go or 'ts' for TypeScript.

```bash
wgc router plugin init starwars --language <preferredLang>
```

--------------------------------

### Initialize a plugin

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/router/plugin/publish.mdx

Initializes a new plugin in the plugins/my-plugin/ directory.

```bash
npx wgc router plugin init my-plugin
```

--------------------------------

### Introspection configuration example

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/configuration.mdx

Example YAML configuration for the Introspection section. The secret is optional and only used when authentication.ignore_introspection is set to true.

```yaml
version: "1"

introspection:
  enabled: true
  secret: "dedicated_secret_for_introspection"
```

--------------------------------

### Query without arguments (GET) - curl

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/connect-rpc/consume-via-rest-openapi.mdx

Use this curl command to call a query method via HTTP GET. Requires query parameters connect=v1, encoding=json, and message={} (empty JSON object). GET is recommended for read-only operations to enable caching.

```bash
curl --get \
  --data-urlencode 'encoding=json' \
  --data-urlencode 'message={}' \
  --data-urlencode 'connect=v1' \
  http://localhost:5026/employees.v1.HrService/GetEmployees
```

--------------------------------

### Install wgc globally with npm

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/intro.mdx

Installs the Cosmo CLI tool globally via npm. Requires Node.js LTS version.

```bash
npm install -g wgc@latest
```

--------------------------------

### Basic HTTP client usage with GET and generic unmarshaling

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/gRPC/plugins/go-plugin/http-client.mdx

Shows how to create an HTTP client with base URL, timeout, and default headers, then perform a GET request and unmarshal the response into a typed struct using generics.

```go
package main

import (
	"context"
	"fmt"
	"time"

	"github.com/wundergraph/cosmo/router-plugin/httpclient"
)

func main() {
	// Create HTTP client with configuration options
	client := httpclient.New(
		httpclient.WithBaseURL("https://api.example.com"),
		httpclient.WithTimeout(10 * time.Second),
		httpclient.WithHeader("Accept", "application/json"),
	)

	// Create a context
	ctx := context.Background()

	// Make a GET request
	resp, err := client.Get(ctx, "/users/1")
	if err != nil {
		panic(err)
	}

	// Check if the request was successful
	if !resp.IsSuccess() {
		fmt.Printf("Request failed with status code: %d\n", resp.StatusCode)
		return
	}

	// Parse the response into a struct using generics
	type User struct {
		ID    int    `json:"id"`
		Name  string `json:"name"`
		Email string `json:"email"`
	}

	user, err := httpclient.UnmarshalTo[User](resp)
	if err != nil {
		panic(err)
	}

	fmt.Printf("User: %s (Email: %s)\n", user.Name, user.Email)
}

```

--------------------------------

### DISALLOW_CASE_INSENSITIVE_ENUM_VALUES: Violation and Correct

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/studio/lint-policy/linter-rules.mdx

Violation example for the DISALLOW_CASE_INSENSITIVE_ENUM_VALUES rule: enum values that differ only by case. Correct example removes the duplicate.

```graphql
enum UserRole {
  ADMIN
  admin
}
```

```graphql
enum UserRole {
  ADMIN
}
```

--------------------------------

### Run Mintlify Dev Server

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/README.md

Run the Mintlify development server at the root of your documentation (where docs.json is) to preview changes locally.

```bash
mintlify dev
```

--------------------------------

### Install wscat globally

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/router/subscriptions.mdx

Installs the wscat WebSocket client globally via npm, which is required to test WebSocket subscriptions against the demo router.

```bash
npm install -g wscat
```

--------------------------------

### wgc grpc-service init usage

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/grpc-service/init.mdx

Shows the basic syntax for the wgc grpc-service init command. Use this to scaffold a new gRPC service project from a template.

```bash
wgc grpc-service init [options]
```

--------------------------------

### REQUIRE_DEPRECATION_DATE: Violation and Correct

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/studio/lint-policy/linter-rules.mdx

Violation example for the REQUIRE_DEPRECATION_DATE rule: @deprecated directive without a date. Correct example includes the date argument.

```graphql
type User {
  id: ID! @deprecated(reason: "No longer in use")
}
```

```graphql
type User {
  id: ID! @deprecated(reason: "No longer in use", date: "2023-01-01")
}
```

--------------------------------

### REQUIRE_DEPRECATION_REASON: Violation and Correct

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/studio/lint-policy/linter-rules.mdx

Violation example for the REQUIRE_DEPRECATION_REASON rule: @deprecated directive without a reason. Correct example includes the reason argument.

```graphql
type User {
  id: ID! @deprecated
}
```

```graphql
type User {
  id: ID! @deprecated(reason: "No longer in use")
}
```

--------------------------------

### Generate Go project with make

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/tutorial/grpc-service-quickstart.mdx

For Go projects, run make to generate all files and download the router. This runs protobuf generation, Connect RPC code generation, router config generation, and router download.

```bash
# Generate all files and download router
make
```

--------------------------------

### ALL_TYPES_REQUIRE_DESCRIPTION: Violation and Correct

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/studio/lint-policy/linter-rules.mdx

Violation example for the ALL_TYPES_REQUIRE_DESCRIPTION rule: type definitions without descriptions. Correct example adds descriptions to each type.

```graphql
type User {
  id: ID!
}

interface Member {
  id: ID!
}
```

```graphql
# Represents a user in the system
type User {
  id: ID!
}

# Represents a member in the system
interface Member {
  id: ID!
}
```

--------------------------------

### Example: npx wgc monograph create production

Source: https://github.com/wundergraph/cosmo-docs/blob/main/docs/cli/monograph/create.mdx

Creates a monograph named "production" with the specified routing URL and GraphQL server endpoint.

```bash
npx wgc monograph create production -r http://router.example.com/graphql -u https://spacex-production.up.railway.app
```
Tokens:
Raw