Skip to content

Commit d8b0ad9

Browse files
authored
Add prerequisite note for Cosmo Cloud Onboarding and CLI setup step (#148)
1 parent 34352d8 commit d8b0ad9

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

docs/tutorial/using-grpc-plugins.mdx

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ icon: plug
99
- [Cosmo CLI](/cli/intro) (minimum version: [0.90.1](https://github.com/wundergraph/cosmo/releases/tag/wgc%400.90.1)) installed and configured
1010
- [Cosmo Router](/router/intro) (minimum version: [0.242.0](https://github.com/wundergraph/cosmo/releases/tag/router%400.242.0)) installed and configured to use Cosmo Cloud
1111

12+
If you're new to Cosmo, you should start with the [Cosmo Cloud Onboarding](/getting-started/cosmo-cloud-onboarding) guide. This guide assumes you've created a federated graph and deployed and configured router(s) for it.
13+
1214
## Overview
1315

1416
gRPC plugins are a powerful new way to write and deploy subgraphs without the need for a GraphQL server. You can use plugins to wrap legacy APIs, mock future subgraphs or fully implement new features. Plugins are written in Go and can be deployed and run automatically by the Cosmo Router.
@@ -44,6 +46,29 @@ Here's a short version of the steps for reference:
4446

4547
---
4648

49+
## Setting up the CLI
50+
51+
Before we start, we should make sure that your version of our CLI `wgc` is up to date and you're logged in.
52+
53+
Check your version with:
54+
```bash
55+
wgc --version
56+
```
57+
58+
<Warning>This needs to be `>=0.90.1` for the tutorial to work correctly.</Warning>
59+
60+
Log in with:
61+
```bash
62+
wgc auth login
63+
```
64+
65+
After logging in, verify your session and ensure you’re in the correct organization by running:
66+
```bash
67+
wgc auth whoami
68+
```
69+
70+
## Building Plugins
71+
4772
First off, let's get familiar with some terminology we use to describe different parts of the platform:
4873

4974
- **Cosmo Cloud**: Our cloud-hosted platform for publishing and monitoring your subgraphs
@@ -54,8 +79,6 @@ First off, let's get familiar with some terminology we use to describe different
5479

5580
Now that we have that sorted, let's move onto the good stuff.
5681

57-
## Building Plugins
58-
5982
### Initialize Plugin
6083

6184
You can create a gRPC plugin using our CLI tool, `wgc`:

0 commit comments

Comments
 (0)