Pitaya Cli

a cli repl client for pitaya, great for testing servers during development
Alternatives To Pitaya Cli
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Volkswagen12,655552 months ago15October 16, 201561mitJavaScript
:see_no_evil: Volkswagen detects when your tests are being run in a CI server, and makes them pass.
6 months ago112otherC
An online request replication tool, also a tcp stream replay tool, fit for real testing, performance testing, stability testing, stress testing, load testing, smoke testing, etc
9 days ago217gpl-2.0C
Gluster Filesystem : Build your distributed storage in minutes
Papercut Smtp2,546
2 months ago38JavaScript
Papercut SMTP -- The Simple Desktop Email Server
Smtp4dev2,241113 months ago69January 07, 202169bsd-3-clauseC#
smtp4dev - the fake smtp email server for development and testing
Mongodb Memory Server2,2206195469 days ago282September 25, 202218mitTypeScript
Spinning up mongod in memory for fast tests. If you run tests in parallel this lib helps to spin up dedicated mongodb servers for every test file in MacOS, *nix, Windows or CI environments (in most cases with zero-config).
Start Server And Test1,3937517263 months ago61September 02, 202172mitJavaScript
Starts server, waits for URL, then runs test command; when the tests end, shuts down server
72 years ago1May 21, 201553otherJava
Dummy SMTP server with GUI for testing emails in applications easily.
4 months ago81June 21, 201830mitGo
Abstruse is a free and open-source CI/CD platform that tests your models and code.
Jsftp7405491654 years ago84January 16, 201851mitJavaScript
Light and complete FTP client implementation for Node.js
Alternatives To Pitaya Cli
Select To Compare

Alternative Project Comparisons


Repo Deprecation Notice

As a part of the initiative to centralize pitaya related code in a single repo, Pitaya CLI is now maintained at the Pitaya main repo.


A REPL cli client made in go for pitaya.


go install github.com/topfreegames/pitaya-cli/v2


For cli flags, run pitaya-cli --help

$ pitaya-cli

Pitaya REPL Client
>>> help

  clear             clear the screen
  connect           connects to pitaya
  disconnect        disconnects from pitaya server
  exit              exit the program
  help              display help
  notify            makes a notify to pitaya server
  push              insert information of push return
  request           makes a request to pitaya server
  sethandshake      sets a handshake parameter


For connecting to a server that uses protobuf as serializer the server must implement two routes:

  • Docs: responsible for returning all handlers and the protos used on input and output;
  • Descriptors: The list of protos descriptions, this will be used by the CLI to encode/decode the messages.

To implement those routes you can use some functions provided by pitaya, here is a short example of both routes:

import (
	// ...


// Docs handler
func (c *MyHandler) Docs(ctx context.Context) (*protos.Doc, error) {
	d, err := pitaya.Documentation(true)
	if err != nil {
		return nil, fmt.Errorf("failed to generate documentation for pitaya routes: %w", err)

	doc, err := json.Marshal(d)
	if err != nil {
		return nil, fmt.Errorf("failed to encode documentation JSON: %w", err)

	return &protos.Doc{Doc: string(doc)}, nil

// Descriptors route
func (c *MyHandler) Descriptors(ctx context.Context, names *protos.ProtoNames) (*protos.ProtoDescriptors, error) {
	descriptors := make([][]byte, len(names.Name))

	for i, protoName := range names.Name {
		desc, err := pitaya.Descriptor(protoName)
		if err != nil {
			return nil, fmt.Errorf("failed to get descriptor for '%s': %w", protoName, err)

		descriptors[i] = desc

	return &protos.ProtoDescriptors{Desc: descriptors}, nil

When initilizing the CLI, you have to provide the docs route as the following:

pitaya-cli -docs connector.docsHandler.docs

NOTE: The descriptors handler is automatically discovered by the client. It must only follow the signature mentioned earlier.

A full example of running pitaya-cli with protobuf:

pitaya-cli -docs connector.docsHandler.docs
>>> push connector.playerHandler.matchfound protos.FindMatchPush
>>> connect localhost:30124
>>> request connector.playerHandler.create
>>> request connector.playerHandler.findmatch {"RoomType":"xxxx"}

Set handshake parameters

You can edit handshake parameters before connecting to the server.

You may pass the full handshake json:

Pitaya REPL Client
>>> sethandshake {"sys":{"clientVersion":"1.0.6", "clientBuildNumber":"999","platform":"ios"}}

Or edit one of three specific parameters:

Pitaya REPL Client
>>> sethandshake platform ios
>>> sethandshake buildNumber 999
>>> sethandshake version 1.0.6

Read commands from file

It's possible to add a list of sequential requests into a file and pitaya-cli will execute them in order.

For example: commands.txt

connect localhost:3250
request connector.playerHandler.create
request connector.playerHandler.findmatch {"RoomType":"xxxx"}

Then run: pitaya-cli --filename commands.txt

Popular Server Projects
Popular Testing Projects
Popular Networking Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.