Getting Started

Follow these steps to call your first gRPC API using Kreya.

Download and install Kreya

You can download Kreya by visiting the download page.

Mac

Download the zip file and extract it. Drag the Kreya.app file into your Applications folder.

Apple Silicon (M1) is not yet supported. More information in this GitHub issue.

Windows

Download the MSI file and run it, which should automatically install Kreya. Should you receive a Windows Defender Smart Screen warning, click on "More info" and then "Run anyway". This happens because the Kreya MSI file currently is not signed with a proper certificate.

Kreya uses Microsoft Edge WebView2, which will be installed when you run the MSI (if it is not already installed).

Linux

The simplest option to install Kreya on Linux is via Snapcraft. Head over to https://snapcraft.io/kreya, select your Linux distribution and follow the guide.

Alternatively, you may install Kreya by downloading the tarball. Note that both libgtk-3 and libwebkit2gtk-4.0 dependencies are required. Install them manually if they aren't present on your system.

Creating a project

Launch Kreya and click the Create project... button, after which you will see the following dialog:

The create project dialog
  1. Since Kreya is file-based, you need to select a location for the Kreya project.
  2. Choose a name for your project.
  3. Enter the directory name. It will be created inside the directory you chose in step 1. All project files will be stored inside this directory.
  4. Ensure that the full path of the project matches your intentions.
  5. By clicking Create, Kreya creates and opens the project.

Adding protobuf files

To create gRPC requests, you need to add protobuf files. Otherwise Kreya cannot know the available services and request/response types.

In the menu, click on Project ā†’ Importers. Here, you need to create a new Importer. Enter a name of your choosing.

Adding via gRPC server reflection

If you have a gRPC service that supports server reflection, you can simply enter its URL. If you want to try Kreya and you don't have any protobuf files, enter https://grpcb.in:9001.

Adding a gRPC importer with server reflection

Adding via local protobuf files

If your protobuf files are stored locally, switch the importer type to gRPC proto files and then select your files.

Adding a gRPC importer with local protobuf files

Creating your first operation

Save and go back to the main screen. Add a new operation by clicking the icon. Choose a descriptive name and select the desired gRPC package, service and method.

Adding a new gRPC operation

Sending your first request

You are almost finished! Click on the settings tab and enter your gRPC service URL in the Endpoint input field. If necessary, edit your request and then send your first request!

Operation with a selected settings tab and a filled endpoint field

Enter https://grpcb.in:9001 as endpoint if you used it as server reflection endpoint.

Good to know

Kreya has a range of features that make your life easier. Be sure to try out the Environment, Authentication, Default Settings and all the other features!