Coral Protocol Quickstart

Check out this guide for a no-nonsense quick setup with Coral Protocol

Requirements

Regardless of the chosen integration method, we will need the following to get started:

• Git
• VS Code or equivalent
• Docker or Gradle
• Node
• Yarn

If you prefer to use Docker, you will require WSL if using Windows.

Setting up the workspace

We’ll begin by creating a folder called “Coral Protocol” where we will be working from, inside this folder, open a new terminal and enter the following to clone the Coral Studio repository:

git clone -b stabletutorial https://github.com/Coral-Protocol/coral-studio studio

Afterwards, we’ll create the server:

git clone -b stabletutorial https://github.com/Coral-Protocol/coral-server server

Once we’re done we’ll have two folders for our the Server and Studio, looking like this:

Desktop
└── Coral Protocol
    ├── Server
    └── Studio

Launching the server

Launching the server can be done with Docker or Gradle.

Gradle

In the same terminal as before, navigate to the server folder using the CD command:

cd server

Once inside the server folder we can run the Coral Server simply by executing the Gradle Wrapper with this command:

Powershell

./gradlew run

Docker

With Docker installed, you’ll need to run the following commands:

# Build the Docker Image
docker build -t coral-server .

# Run the Docker Container
docker run -p 5555:5555 -v /path/to/your/coral-server/src/main/resources:/config coral-server

Launching Coral Studio

First we’ll need to open our Studio folder inside VS Code, to do this you can navigate to the File menu on the top left, and click Open Folder, or use the below shortcuts:

1. Press CTRL + K
2. Press CTRL + O

In the new window pop up, go to your Coral Protocol folder that we created earlier, and open the folder Studio

With the folder opened, we need to run the project, for this we will be using Yarn to install all the packages and launch Coral Studio.

Open a terminal by navigating to Terminal and clicking New Terminal, or press CTRL + '

1. In the new terminal, enter the following:

npm install -g corepack

2. Once installation has completed, do:

yarn dev

Done! Coral Studio will now be hosted locally on your machine and be accessable via the address commented in the terminal once completed, typically at localhost:3000 which you can visit on your browser like any normal URL.

Final steps

As soon as you visit the locally hosted Coral Studio tool, it will bring you through a tutorial to add the server, which is as simple as writing out the address listed on the Terminal that we opened it with earlier, and pressing Connect.

Now that we have Coral Studio and Coral Server running and connected, we have completed this tutorial, you may want to check out the following for next steps:

Setup your first Session
Learn more about Agents
Integrate the Coral Server with your application

If you experience any problems with this guide, please check out the Troubleshooting page for common issues, and feel free to reach out to our support at [e-mail] or visit our Discord for a quick response.