Skip to main content

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 may happen because Windows doesn't trust the Kreya code signature enough yet.

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.

Using the example project#

If you just want to try Kreya a bit, the example project is a good start. It uses a lot of advanced features like Default Settings to create an easy-to-use gRPC client for grpcbin. Just select it and it will be cloned to your disk.

The initial launch screen

To send your first request, you have to select an environment in the upper-left corner (it doesn't matter that much if you choose http or https). Then, simply select an operation and hit 'Send'.

Sending a request with the example project

Manually creating a project#

If you want to create your own 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 definitions#

To create gRPC requests, you need to add protobuf definitions, otherwise Kreya cannot know the available services and request/response types. You can do this via the initial project setup screen or later by adding an Importer if you choose to skip this step.

Adding a gRPC importer via the initial project setup

Select an importer type, enter the necessary information and click 'Save'. If you want to try Kreya and you don't have any protobuf files at hand, enter https://grpcb.in:9001. Kreya will automatically generate an operation for each service method of your gRPC service.

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!