Installation#

Prerequisites#

  • Python 3.12 or later

  • Docker (required for building and running ops as containers)

Install gyoza#

With pip:

pip install gyoza@git+https://github.com/g-e-o-i-a/gyoza.git

With uv:

uv pip install gyoza@git+https://github.com/g-e-o-i-a/gyoza.git

Verify the installation#

After installation the gyoza CLI should be available on your environment:

gyoza --version

Environment variables#

The gyoza SDK and CLI need to know where the server is and how to authenticate. Set the following variables in your shell, .env file, or .bashrc:

Variable

Default

Description

GYOZA_SERVER_URL

http://localhost:5555

Base URL of the gyoza server.

GYOZA_API_KEY

(empty)

API key sent as the X-API-Key header on every request. Must match the key configured on the server.

 
export GYOZA_SERVER_URL="http://localhost:5555"
export GYOZA_API_KEY="my-secret-key"

See also

Start developing your first op by following the Quickstart guide.