YoMo

https://github.com/yomorun/yomo
Admin
YoMo is an open-source LLM Function Calling Framework for building scalable and ultra-fast AI...
Tokens:4,477
Snippets:44
Trust Score:7.8
License:Apache-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install YoMo CLI using curl

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/intro.mdx

Downloads and executes the official YoMo CLI installation script directly from the web using curl. This command fetches the script and pipes it to the shell for execution.

```bash
curl -fsSL https://get.yomo.run | sh
```

--------------------------------

### Install YoMo CLI

Source: https://github.com/yomorun/yomo/blob/master/docs/quickstart.mdx

Installs the YoMo command-line interface using a curl script downloaded from get.yomo.run.

```sh
curl -fsSL "https://get.yomo.run" | sh
```

--------------------------------

### Check YoMo CLI version

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/intro.mdx

Displays the currently installed version of the YoMo command-line interface. This is useful for verifying a successful installation and checking the specific version being used.

```bash
yomo version
```

--------------------------------

### Run YoMo LLM Function

Source: https://github.com/yomorun/yomo/blob/master/docs/quickstart.mdx

Starts the previously initialized serverless LLM function, connecting it to the running YoMo server to begin processing events.

```sh
yomo run
```

--------------------------------

### Install YoMo CLI Binary (Shell)

Source: https://github.com/yomorun/yomo/blob/master/cli/README.md

Installs the latest YoMo CLI binary using a curl script. This is the recommended way for quick installation.

```sh
go install github.com/yomorun/yomo/cmd/yomo@latest
```

--------------------------------

### Running YoMo Source with TLS (Bash)

Source: https://github.com/yomorun/yomo/blob/master/scripts/README.md

This command starts a YoMo Source (client) with TLS encryption enabled. It sets environment variables for TLS configuration (CA, client cert/key) and specifies the YoMo server address using the configured hostname.

```bash
YOMO_TLS_VERIFY_PEER=true \
YOMO_TLS_CACERT_FILE=tls/ca.crt \
YOMO_TLS_CERT_FILE=tls/client_source.crt \
YOMO_TLS_KEY_FILE=tls/client_source.key \
YOMO_ADDR=yomo-app.dev:9000 \
go run ../example/0-basic/source/main.go
```

--------------------------------

### Running YoMo Zipper with TLS (Bash)

Source: https://github.com/yomorun/yomo/blob/master/scripts/README.md

This command starts the YoMo Zipper (server) with TLS encryption enabled. It sets environment variables pointing to the CA, server certificate, and server key files, and enables peer verification.

```bash
YOMO_TLS_VERIFY_PEER=true \
YOMO_TLS_CACERT_FILE=tls/ca.crt \
YOMO_TLS_CERT_FILE=tls/server.crt \
YOMO_TLS_KEY_FILE=tls/server.key \
yomo serve -c ../example/0-basic/config.yaml
```

--------------------------------

### Example Workflow for Initializing a YoMo Function (Shell)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/init.mdx

This example demonstrates the typical workflow after running `yomo init`. It shows the command execution, the output indicating successful initialization, changing into the newly created project directory, and the resulting file structure using the `tree` command.

```sh
ᐅ yomo init tool-get-weather

⌛  Initializing the Stream Function...
✅  Congratulations! You have initialized the stream function successfully.

ᐅ cd tool-get-weather

ᐅ tree . 

drwxr-xr-x@   - c3ylabs 15 Apr 10:00 tool-get-weather
.rw-r--r--@  53 c3ylabs 15 Apr 10:00 ├── .env
.rw-r--r--@  32 c3ylabs 15 Apr 10:00 ├── .gitignore
.rw-r--r--@ 391 c3ylabs 15 Apr 10:00 ├── package.json
.rw-r--r--@ 14k c3ylabs 15 Apr 10:00 ├── pnpm-lock.yaml
drwxr-xr-x@   - c3ylabs 15 Apr 10:00 ├── src
.rw-r--r--@ 612 c3ylabs 15 Apr 10:00 │   └── app.ts
.rw-r--r--@ 266 c3ylabs 15 Apr 10:00 └── tsconfig.json
```

--------------------------------

### Start yomo Zipper Service (Bash)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/serve.mdx

Use this command to start the yomo zipper service, specifying the path to the configuration file.

```bash
yomo serve -c zipper.yaml
```

--------------------------------

### Example: Running a Specific LLM Function (Bash)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/run.mdx

Illustrates how to run a previously initialized LLM function named 'get-weather', connecting to a Zipper instance at 'localhost:9000'. The output shows the function starting and connecting.

```bash
ᐅ yomo run -z localhost:9000 -n get-weather

ℹ️  YoMo Serverless LLM Function file: /Users/fanweixiao/tmp/cccc/333/src/app.ts
⌛  Creating YoMo Serverless LLM Function instance...
Lockfile is up to date, resolution step is skipped
Already up to date
Done in 208ms using pnpm v10.8.0
ℹ️  Starting YoMo Serverless LLM Function instance, connecting to zipper: localhost:9000
ℹ️  Serverless LLM Function is running...
2025/04/15 15:14:50 Bun is installed, bun version: 1.2.9
3:14PM INF connected to zipper service=stream-function sfn_id=CPwVS0v5nw_7d9UwbuJao sfn_name=get-weather zipper_addr=localhost:9000
ℹ️  [get-weather] waiting request...
```

--------------------------------

### Build YoMo CLI from Source to Specific Directory (Go)

Source: https://github.com/yomorun/yomo/blob/master/cli/README.md

Installs the latest YoMo CLI from source into a specified directory by setting the GOBIN environment variable. Requires Go to be installed.

```sh
env GOBIN=/bin go install github.com/yomorun/yomo/cmd/yomo@latest
```

--------------------------------

### Run YoMo Server

Source: https://github.com/yomorun/yomo/blob/master/docs/quickstart.mdx

Starts the main YoMo server process (Zipper), which acts as the Message Control Plane (MCP) and handles data flow and function execution.

```sh
yomo serve
```

--------------------------------

### Initialize YoMo LLM Function

Source: https://github.com/yomorun/yomo/blob/master/docs/quickstart.mdx

Initializes a new YoMo serverless function project specifically for LLM tool calling, creating a directory with boilerplate code and configuration files.

```sh
yomo init tool-get-weather
```

--------------------------------

### View LLM Function Directory Structure

Source: https://github.com/yomorun/yomo/blob/master/docs/quickstart.mdx

Displays the file and directory structure created by the `yomo init` command for the new LLM function project.

```sh
$ tree ool-get-weather
```

--------------------------------

### Running YoMo Stream Function with TLS (Bash)

Source: https://github.com/yomorun/yomo/blob/master/scripts/README.md

This command starts a YoMo Stream Function (client) with TLS encryption enabled. It sets environment variables for TLS configuration (CA, client cert/key) and specifies the YoMo server address using the configured hostname.

```bash
YOMO_TLS_VERIFY_PEER=true \
YOMO_TLS_CACERT_FILE=tls/ca.crt \
YOMO_TLS_CERT_FILE=tls/client_sfn.crt \
YOMO_TLS_KEY_FILE=tls/client_sfn.key \
YOMO_ADDR=yomo-app.dev:9000 \
go run ../example/0-basic/sfn/main.go
```

--------------------------------

### Starting YoMo Zipper with Config (Shell)

Source: https://github.com/yomorun/yomo/blob/master/pkg/bridge/ai/provider/ollama/Readme.md

Starts the YoMo Zipper service using the specified configuration file (config.yml). This command initializes the YoMo server with the defined settings, including the AI bridge configuration.

```sh
yomo serve -c config.yml
```

--------------------------------

### Install YoMo CLI (bash)

Source: https://github.com/yomorun/yomo/blob/master/README.md

Installs the YoMo command-line interface using a curl script downloaded from the official source.

```bash
curl -fsSL https://get.yomo.run | sh
```

--------------------------------

### Run YoMo Source Application (Go)

Source: https://github.com/yomorun/yomo/blob/master/cli/README.md

Navigates to the source application directory and runs the main Go file. This starts the source application that sends data to the Zipper.

```sh
cd ../example/9-cli/source

go run main.go
```

--------------------------------

### Run YoMo-Zipper with Configuration (Shell)

Source: https://github.com/yomorun/yomo/blob/master/cli/README.md

Starts the YoMo-Zipper server using the specified configuration file. Ensure the config file path is correct.

```sh
yomo serve --config ../example/config.yaml
```

--------------------------------

### Start YoMo Agent Server (sh)

Source: https://github.com/yomorun/yomo/blob/master/README.md

Launches the YoMo agent server using the specified YAML configuration file.

```sh
yomo serve -c my-agent.yaml
```

--------------------------------

### Verify YoMo CLI Installation (bash)

Source: https://github.com/yomorun/yomo/blob/master/README.md

Checks the installed version of the YoMo CLI to confirm that the installation was successful.

```bash
yomo version
```

--------------------------------

### Commit Message Example

Source: https://github.com/yomorun/yomo/blob/master/CONTRIBUTING.md

An example of a commit message demonstrating the specified format, including type (feat), scope (plugin), subject, body explaining the change, and a footer linking to an issue.

```text
feat(plugin): support the development of streaming plugins

The user implements the YomoStreamPlugin interface, and with yomo.RunStream function starts a service that supports stream data processing

Close #18
```

--------------------------------

### Installing YoMo SFN Package (Bash)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/spec.mdx

Command to install the `@yomo/sfn` package using npm, which is required to use the YoMo TypeScript framework for building serverless functions.

```bash
npm install @yomo/sfn
```

--------------------------------

### Running Ollama Model (Shell)

Source: https://github.com/yomorun/yomo/blob/master/pkg/bridge/ai/provider/ollama/Readme.md

Executes the 'mistral' model using the Ollama command-line interface. This command downloads the model if not already present and starts the inference server for that model.

```sh
ollama run mistral
```

--------------------------------

### Defining Tool Description (TypeScript)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/spec.mdx

Example showing how to define the `description` string for a YoMo tool. This string provides a human-readable explanation of the tool's functionality for the LLM.

```typescript
const description = "Get the current weather for \`city_name\`";
```

--------------------------------

### YoMo Agent Configuration (YAML)

Source: https://github.com/yomorun/yomo/blob/master/README.md

Example YAML configuration file for a YoMo agent, defining network settings (host, port), authentication (token), and AI bridge settings including the OpenAI API compatible endpoint and available LLM providers (vllm, ollama) with their respective API endpoints and models.

```yaml
name: my-agent
host: 0.0.0.0
port: 9000

auth:
  type: token
  token: SECRET_TOKEN

bridge:
  ai:
    server:
      addr: 0.0.0.0:9000 ## OpenAI API compatible endpoint
      provider: vllm     ## llm to use

    providers:
      vllm:
        api_endpoint: http://127.0.0.1:8000/v1
        model: meta-llama/Llama-4-Scout-17B-16E-Instruct

      ollama:
        api_endpoint: http://localhost:11434
```

--------------------------------

### Generating Default YoMo TLS Certificates (Bash)

Source: https://github.com/yomorun/yomo/blob/master/scripts/README.md

This script executes the default certificate generation scripts for the CA, server, and client (source and sfn) components required for YoMo TLS communication. It requires OpenSSL >= 1.1.1.

```bash
./generate_ca.sh

./generate_server.sh

./generate_client.sh source

./generate_client.sh sfn
```

--------------------------------

### Adding YoMo Hostname to /etc/hosts (Bash)

Source: https://github.com/yomorun/yomo/blob/master/scripts/README.md

This command adds an entry to the local `/etc/hosts` file, mapping the default YoMo server name `yomo-app.dev` to the loopback address `127.0.0.1`. This allows the client services to resolve the server hostname locally.

```bash
sudo echo '127.0.0.1 yomo-app.dev' | sudo tee -a /etc/hosts
```

--------------------------------

### Implementing Tool Handler Function (TypeScript)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/spec.mdx

Example showing the implementation of the asynchronous `handler` function. This function contains the core logic of the tool, accepting arguments defined by the `Argument` type and returning a result object.

```typescript
export async function handler(args: Argument) {
  const result = await getWeather(args.city_name)
  return result
}
```

--------------------------------

### Generating YoMo Server TLS Certificate for Custom Hostname (Bash)

Source: https://github.com/yomorun/yomo/blob/master/scripts/README.md

This script generates a server certificate specifically for a custom DNS name (e.g., "abc.test") instead of the default "yomo-app.dev". This is useful when deploying YoMo with a different hostname.

```bash
./generate_server.sh abc.test
```

--------------------------------

### Defining Tool Argument Type (TypeScript)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/spec.mdx

Example defining the `Argument` type using TypeScript. This type specifies the expected structure and types of input data for the tool's handler function, used by the framework to generate JSONSchema.

```typescript
export type Argument = {
  /**
   * The name of the city to be queried
   */
  city_name: string;
}
```

--------------------------------

### Usage Syntax for yomo init Command (Bash)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/init.mdx

This snippet shows the basic command-line syntax for using `yomo init`. It indicates that the command takes optional flags and a required argument for the tool name.

```bash
yomo init [flags] tool-name
```

--------------------------------

### Build YoMo Stream Function (Shell)

Source: https://github.com/yomorun/yomo/blob/master/cli/README.md

Navigates to the Stream Function directory and builds the Go application using the YoMo CLI. Defaults to a native binary, use `-w` for WebAssembly.

```sh
cd ../example/9-cli/sfn

yomo build
```

--------------------------------

### Basic Usage of yomo run Command (Bash)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/run.mdx

Provides the fundamental syntax for executing the `yomo run` command, showing the required arguments for flags and the tool name.

```bash
yomo run [flags] tool-name
```

--------------------------------

### Run Static Linting (Go)

Source: https://github.com/yomorun/yomo/blob/master/CONTRIBUTING.md

This command executes the golangci-lint tool to perform static analysis on the Go codebase. It checks for code style issues, potential bugs, and other code quality problems as part of the submission guidelines.

```Shell
golangci-lint run
```

--------------------------------

### Configuring YoMo Zipper for Ollama (YAML)

Source: https://github.com/yomorun/yomo/blob/master/pkg/bridge/ai/provider/ollama/Readme.md

Defines the configuration for the YoMo Zipper service, specifying the host and port, and configuring the AI bridge to use Ollama as a provider, pointing to the Ollama API endpoint.

```yaml
name: Service
host: 0.0.0.0
port: 9000

bridge:
  ai:
    server:
      addr: "localhost:8000"
      provider: ollama
    providers:
      ollama:
        api_endpoint: "http://localhost:11434/v1"
```

--------------------------------

### yomo Zipper Configuration (YAML)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/serve.mdx

This YAML file configures the yomo zipper service, defining its name, network host and port, authentication method, and settings for the LLM bridge and its various AI providers.

```yaml
name: llm-bridge
host: 0.0.0.0
port: 9000

auth:
 type: token
 token: YOUR_SECRET

bridge:
  ai:
    server:
      addr: localhost:9000
      provider: vllm

    providers:
      vllm:
        api_endpoint: http://127.0.0.1:9999/v1
        api_key: <api_key>
        model: deepseek-ai/DeepSeek-R1-Distill-Llama-70B

      ollama:
        api_endpoint: http://localhost:11434

      openai:
        api_key: <sk-proj->
        model: gpt-4.1

      gemini:
        api_key: <api_key>

      anthropic:
        api_key: <sk-ant-api03-key>
        model: claude-3.7-sonnet

      vertexai:
        project_id: <gcp_project_id>
        credentials_file: <gcp_credential_json_file>
        model: gemini-2.5-pro-preview-03-25
        location: us-central1

      azopenai:
        api_endpoint: https://c3y.openai.azure.com
        deployment_id: <deployment_id>
        api_key: <api_key>
        api_version: 2024-06-01

      xai:
        api_key: <xai-key>
        model: grok-beta

      githubmodels:
        api_key: <ghp_key>

      cloudflare_azure:
        endpoint: https://gateway.ai.cloudflare.com/v1/<cf-id>/ai-test
        api_key: <api_key>
        resource: <resource>
        deployment_id: <deployment_id>
        api_version: 2024-05-13

      cloudflare_openai:
        endpoint: https://gateway.ai.cloudflare.com/v1/<cf-id>/ai-test
        api_key: <sk-proj->
        model: gpt-4.1
```

--------------------------------

### Run YoMo Function (bash)

Source: https://github.com/yomorun/yomo/blob/master/README.md

Executes the implemented YoMo function named `get-weather` using the YoMo CLI.

```bash
$ yomo run -n get-weather
```

--------------------------------

### Default Generated YoMo Function Code (TypeScript)

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/init.mdx

This snippet shows the default content of the `src/app.ts` file generated by `yomo init`. It includes the function description, a TypeScript type definition for arguments using JSDoc for schema generation, a simulated asynchronous helper function (`getWeather`), and the main `handler` function that processes the arguments and returns a result.

```typescript
export const description = 'Get the current weather for `city_name`'

// For jsonschema in TypeScript, see: https://github.com/YousefED/typescript-json-schema
export type Argument = {
  /**
   * The name of the city to be queried
   */
  city_name: string;
}

async function getWeather(city_name: string) {
  // Simulate a weather API call
  let tempraure = Math.floor(Math.random() * 41)
  console.log(`get weather for ${city_name} with temperature ${tempraure}°C`)
  return { city_name: city_name, temperature: tempraure }
}

export async function handler(args: Argument) {
  const result = await getWeather(args.city_name)
  return result
}
```

--------------------------------

### Testing Geocode and Weather Functions with Bun Test

Source: https://github.com/yomorun/yomo/blob/master/docs/sfn/spec.mdx

This snippet demonstrates how to write tests for asynchronous functions (`getGeocode`, `getWeather`) using the `bun:test` framework. It includes tests to verify the accuracy of geocoding results and the structure/content of weather data.

```typescript
import { expect, test } from "bun:test";
import { getGeocode, getWeather } from "../src/app";

test('getGeocode', async () => {
        const address = '1600 Amphitheatre Parkway, Mountain View, CA';
        const result = await getGeocode(address);
        expect(result.lat).toBeCloseTo(37.4193295);
        expect(result.lng).toBeCloseTo(-122.0816532);
})

test('getWeatherByGoogleAPI', async () => {
        const lat = 37.4193295;
        const lng = -122.0816532;
        const result = await getWeather(lat, lng);
        expect(result).toBeDefined();
        expect(result.timeZone.id).toBe('America/Los_Angeles');
        expect(result.temperature).toBeDefined();
});
```

--------------------------------

### Run YoMo Stream Function (Shell)

Source: https://github.com/yomorun/yomo/blob/master/cli/README.md

Runs the built Stream Function binary using the YoMo CLI. This connects the function to the YoMo data stream.

```sh
yomo run sfn.yomo
```

--------------------------------

### Implement Weather Function Calling (TypeScript)

Source: https://github.com/yomorun/yomo/blob/master/README.md

Defines a TypeScript function (`handler`) intended for LLM function calling. It includes a description for the LLM, a type-safe argument structure (`Argument`) for the city name, and simulates fetching weather data, returning a structured result.

```typescript
export const description = 'Get the current weather for `city`'

export type Argument = {
  /**
   *
   * The name of the city to be queried
   */
  city: string;
}

export async function handler(args: Argument) {
  // Simulate a weather API call
  let temperature = Math.floor(Math.random() * 41)
  // Return the result to LLM
  return { 
    city: args.city, 
    temperature: temperature,
    feels_like: 11.9,
    rain: false,
  }
}
```

--------------------------------

### Test LLM Chat Completion with Curl (sh)

Source: https://github.com/yomorun/yomo/blob/master/README.md

Sends a chat completion request to the running YoMo agent server's OpenAI API compatible endpoint using curl. Includes setting content type, authorization header with a bearer token, and providing a JSON payload containing the user message.

```sh
curl http://127.0.0.1:9000/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer SECRET_TOKEN" \
-d '{
  "messages": [
    {
      "role": "user",
      "content": "I am going for a hike on the Yarra Bend Park Loop. What should I wear?"
    }
  ],
  "stream": false
}'
```

--------------------------------

### Commit Message Template

Source: https://github.com/yomorun/yomo/blob/master/CONTRIBUTING.md

Provides a template for structuring commit messages, including placeholders for type, scope, subject, body, and footer, separated by blank lines.

```html
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```
Tokens:
Raw