Yaklang API Manual

https://yaklang.com/api-manual/
Admin
This document provides a comprehensive API manual for Yaklang, detailing its built-in libraries,...
Tokens:135,194
Snippets:1,345
Trust Score:2.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### toolbox.force

Source: https://yaklang.com/api-manual/api/toolbox

Creates an InstallOptionFunc to force the installation.

```APIDOC
## toolbox.force

### Description
Returns an `InstallOptionFunc` that enables or disables a forced installation. When set to true, it may override existing installations or perform other forceful actions.

### Method
Not applicable (SDK function)

### Signature
`force(force bool) InstallOptionFunc`

### Parameters
#### force
- **force** (bool) - Required - A boolean value indicating whether to force the installation.

### Returns
- **InstallOptionFunc** - An option function that can be passed to `toolbox.Install`.
```

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

### Yak Module File Example

Source: https://yaklang.com/api-manual/buildinlibs/lib_dyn

This is an example of a Yak module file (`.yak`) that can be loaded by `dyn.LoadVarFromFile`. It defines a module name, a variable, and a function.

```go
YAK_MOD = "testmod"
testvar = 123
func abc() {
    log.info("print submod abc...")
    println("am is submod.yak")
}
```

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

### toolbox.context

Source: https://yaklang.com/api-manual/api/toolbox

Creates an InstallOptionFunc that sets the context for installation.

```APIDOC
## toolbox.context

### Description
Returns an `InstallOptionFunc` that allows specifying a `context.Context` for the installation operation. This is useful for managing deadlines and cancellations.

### Method
Not applicable (SDK function)

### Signature
`context(ctx context.Context) InstallOptionFunc`

### Parameters
#### ctx
- **ctx** (context.Context) - Required - The context to use for the installation.

### Returns
- **InstallOptionFunc** - An option function that can be passed to `toolbox.Install`.
```

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

### toolbox.progress

Source: https://yaklang.com/api-manual/api/toolbox

Creates an InstallOptionFunc to set a progress callback for the installation.

```APIDOC
## toolbox.progress

### Description
Returns an `InstallOptionFunc` that registers a callback function to receive progress updates during the installation process. This allows for monitoring the installation's status.

### Method
Not applicable (SDK function)

### Signature
`progress(progress ProgressCallback) InstallOptionFunc`

### Parameters
#### progress
- **progress** (ProgressCallback) - Required - The callback function to be invoked with progress updates.

### Returns
- **InstallOptionFunc** - An option function that can be passed to `toolbox.Install`.
```

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

### toolbox.proxy

Source: https://yaklang.com/api-manual/api/toolbox

Creates an InstallOptionFunc to set the proxy for installation.

```APIDOC
## toolbox.proxy

### Description
Returns an `InstallOptionFunc` that specifies the proxy server to be used during the installation. This is useful in environments where direct network access is restricted.

### Method
Not applicable (SDK function)

### Signature
`proxy(proxy string) InstallOptionFunc`

### Parameters
#### proxy
- **proxy** (string) - Required - The proxy server address (e.g., "http://proxy.example.com:8080").

### Returns
- **InstallOptionFunc** - An option function that can be passed to `toolbox.Install`.
```

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

### toolbox.List

Source: https://yaklang.com/api-manual/api/toolbox

Lists the status of installed binaries.

```APIDOC
## toolbox.List

### Description
Retrieves a list of installed binaries and their statuses.

### Method
Not applicable (SDK function)

### Signature
`List() ([]*BinaryStatus, error)`

### Parameters
None

### Returns
- **[]*BinaryStatus** - A slice of BinaryStatus objects representing installed binaries.
- **error** - An error if the listing fails, otherwise nil.
```

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

### toolbox.Install

Source: https://yaklang.com/api-manual/api/toolbox

Installs a binary with the given name and options. Options can include context, force flag, progress callback, and proxy settings.

```APIDOC
## toolbox.Install

### Description
Installs a binary with the specified name. Accepts variadic `InstallOptionFunc` arguments to customize the installation process.

### Method
Not applicable (SDK function)

### Signature
`Install(name string, options ...InstallOptionFunc) error`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### name
- **name** (string) - Required - The name of the binary to install.
#### options
- **options** (...InstallOptionFunc) - Optional - Functions to configure the installation, such as `context`, `force`, `progress`, or `proxy`.

### Returns
- **error** - An error if the installation fails, otherwise nil.
```

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

### Start Web Crawler with Basic Configuration

Source: https://yaklang.com/api-manual/api/crawlerx

Initiates a web crawling task using a headless browser. Configure with options like page timeout and concurrency.

```Go
targetUrl = "http://testphp.vulnweb.com/"
ch, err = crawlerx.StartCrawler(targetUrl, crawlerx.pageTimeout(30), crawlerx.concurrent(3))
for item = range ch {
    yakit.Info(item.Method() + " " + item.Url())
}
```

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

### StartSniff

Source: https://yaklang.com/api-manual/api/pcapx

Starts network sniffing on a specified interface. Returns an error if sniffing cannot be started.

```APIDOC
## StartSniff

### Description
Starts network sniffing on a specified interface. Returns an error if sniffing cannot be started.

### Method
Not specified (likely internal or part of a larger operation)

### Endpoint
Not applicable

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **iface** (`string`) - The network interface to sniff on.
- **opts** (`...CaptureOption`) - Optional capture options.
```

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

### Setting up a WebSocket Route Handler

Source: https://yaklang.com/api-manual/api/httpserver

Use `wsRouteHandler` to define a WebSocket endpoint. This example sets up a handler for the '/ws' route that echoes back received messages.

```go
err = httpserver.Serve("127.0.0.1", 8888, httpserver.wsRouteHandler("/ws", func(conn) {
    rawReq := conn.GetRawRequest() // 获取原始 HTTP 请求
    for {
        messageType, message, err = conn.ReadMessage()
        if err != nil {
            return
        }
        conn.WriteMessage(messageType, message) // echo back
    }
}))
```

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

### Start MITM Proxy and Bridge HTTPS Traffic

Source: https://yaklang.com/api-manual/buildinlibs/lib_mitm

This snippet demonstrates how to start a MITM proxy server and then bridge its traffic to another proxy. It includes setting up callbacks to log intercepted requests and responses, specifically for HTTPS traffic.

```go
// 启动一个 mitm 劫持服务器go mitm.Start(8084, mitm.callback(fn(isHttps, url, request, response){
    println("请求经过了代理服务器")
}))
go mitm.Bridge(8086, "http://127.0.0.1:8084", mitm.callback(fn(
    isHttps, url, request, response,){
    if (!isHttps) {
        return
    }
    println("劫持到了 HTTPS！")
    println("请求经过了桥接模式的中间人！你已经被黑了，Hacked by yaklang")
    http.show(request)
    http.showhead(response)
}))
// 等待一秒：等待 mitm 代理服务器和桥接器完全启动sleep(1)

// 发送一个 Get 请求，设置代理：代理为我们刚启动的 http mitm 服务器
rsp, err := http.Get("https://www.baidu.com", http.proxy("http://127.0.0.1:8086"))
die(err)
```

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

### aiagent.offsetSeq

Source: https://yaklang.com/api-manual/api/aiagent

Sets the starting sequence/ID and installs a simple incrementing ID generator.

```APIDOC
## offsetSeq

### Description
Sets the starting sequence/ID and installs a simple ID generator that increments it.

### Definition
`offsetSeq(start int)`

### Parameters
- **start** (`int`) - The starting sequence or ID number.
```

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

### Combined Request and Response Example

Source: https://yaklang.com/api-manual/buildinlibs/lib_http

This shows the raw HTTP request followed by its corresponding HTTP response, including headers and status.

```http
HEAD /yourpath HTTP/1.1
Host: baidu.com
Bar: FOO

HTTP/1.1 200 OK
Content-Length: 19825
Accept-Ranges: bytes
Cache-Control: max-age=86400
Content-Type: text/html
Date: Sat, 12 Jun 2021 12:47:43 GMT
Etag: "4d71-5bd28c3bf7800"
Expires: Sun, 13 Jun 2021 12:47:43 GMT
Last-Modified: Wed, 10 Mar 2021 06:27:44 GMT
P3p: CP=" OTI DSP COR IVA OUR IND COM "
Server: Apache
Set-Cookie: BAIDUID=378636EDCB30B5B26C7A96757C45D396:FG=1; expires=Sun, 12-Jun-22 12:47:43 GMT; max-age=31536000; path=/; domain=.baidu.com; version=1
Vary: Accept-Encoding,User-Agent



```

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

### withEntryFile

Source: https://yaklang.com/api-manual/api/ssa

Sets the entry file for the SSA process. This option specifies the main file to start analysis from.

```APIDOC
## withEntryFile

### Description
Sets the entry file for the SSA process. This option specifies the main file to start analysis from.

### Signature
`withEntryFile(v ...string) ssaconfig.Option`

### Parameters
#### Parameters
- **v** (string...) - The entry file(s).
```

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

### Perform a Full-Connection Scan

Source: https://yaklang.com/api-manual/api/servicescan

Initiates a full-connection port scan on a target address and specified ports. It returns a channel for results and an error. The example demonstrates how to iterate through the results, check if a port is open, and retrieve CPE information.

```go
ch, err = servicescan.Scan("127.0.0.1", "22-80,443,3389")  // 开始扫描，函数会立即返回一个错误和结果管道
die(err) // 如果错误非空则报错
for result := range ch { // 通过遍历管道的形式获取管道中的结果
       if result.IsOpen() { // 获取到的结果是一个结构体，可以调用IsOpen方法判断该端口是否打开           println(result.String()) // 输出结果，调用String方法获取可读字符串           println(result.GetCPEs()) // 查看 CPE 结果       }
    }
```

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

### hids.GetProcessTree

Source: https://yaklang.com/api-manual/api/hids

Retrieves the process tree, starting from a specified PID or the init process.

```APIDOC
## hids.GetProcessTree

### Description
Retrieves the process tree, starting from a specified PID or the init process.

### Method
`GetProcessTree(pid int)`

### Parameters
- **pid** (int) - The starting Process ID. If not specified, it starts from the init process.
```

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

### Lines Option Example

Source: https://yaklang.com/api-manual/api/aireducer

WithLines sets the line trigger for chunking. Chunks will be created every N lines. If the N lines content is smaller than ChunkSize, it will be kept intact. If larger than ChunkSize, it will be split according to ChunkSize.

```go
NewReducerFromFile("file.txt", aireducer.WithLines(10), aireducer.WithChunkSize(1024))    // This will create chunks every 10 lines, but if 10 lines exceed 1024 bytes,    // they will be split at 1024 byte boundaries.
```

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

### Get All Command-Line Arguments

Source: https://yaklang.com/api-manual/buildinlibs/lib_cli

Retrieves all command-line arguments passed to the script. Use `dump(args)` to display the parsed arguments.

```yak
args = cli.Args()  // 获取所有命令行参数内容dump(args)         // 展示参数结果
```

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

### Raw HTTP Request Example

Source: https://yaklang.com/api-manual/buildinlibs/lib_http

This displays the raw structure of an HTTP HEAD request with custom headers, as constructed by http.NewRequest.

```http
HEAD /yourpath HTTP/1.1
Host: baidu.com
Bar: FOO


```

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

### Get Current CPU Percentage

Source: https://yaklang.com/api-manual/api/hids

Retrieves the current system's CPU utilization percentage. This provides a snapshot of CPU usage.

```go
printf("%f%%\n", hids.CPUPercent())
```

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

### Get CPU Average Usage

Source: https://yaklang.com/api-manual/api/hids

Retrieves the current system's average CPU utilization. Use this to monitor overall CPU load.

```go
printf("%f%%\n", hids.CPUAverage())
```

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

### Get Gadget Name from Function Pointer

Source: https://yaklang.com/api-manual/api/yso

Extracts the gadget name from a function pointer. The function name must follow the 'Get _JavaObject' format, and the part between 'Get ' and 'JavaObject' is returned as the gadget name.

```Go
name, err := GetGadgetNameByFun(GetCommonsBeanutils1JavaObject)// name = "CommonsBeanutils1"
```

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

### Send GET Request with Timeout

Source: https://yaklang.com/api-manual/api/http

Use http.Get to send a GET request to a specified URL. This function is deprecated and poc.Get is recommended. You can configure options like timeout.

```go
rsp, err = http.Get("http://www.yaklang.com", http.timeout(10))
```

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

### Create and Use a Read-Write Mutex (sync.NewRWMutex)

Source: https://yaklang.com/api-manual/api/sync

Demonstrates creating a RWMutex using sync.NewRWMutex() for scenarios where multiple readers can access data concurrently, but writes require exclusive access. This optimizes performance for read-heavy workloads.

```go
m = sync.NewRWMutex()
newMap = make(map[string]string)
go func(){
for {
m.Lock()         // 请求写锁
defer m.Unlock() // 释放写锁
newMap["key"] = "value" // 防止多个并发任务同时修改 newMap
}
}
for {
m.RLock()         // 请求读锁
defer m.RUnlock() // 释放读锁
println(newMap["key"])
}

```

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

### Performing an HTTP Request and Showing Response

Source: https://yaklang.com/api-manual/buildinlibs/lib_http

Build an HTTP request using http.NewRequest, execute it with http.Do, and then display the response information using http.show. Error handling is crucial.

```go
req, err = http.NewRequest("HEAD", "http://baidu.com/yourpath", http.header("BAR", "FOO"))
die(err)
http.show(req)    
rsp, err = http.Do(req)
if err != nil {
    die(err)}
http.show(rsp)                                # 展示相应信息
```

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

### Establish SSH Connection with Flexible Options

Source: https://yaklang.com/api-manual/api/ssh

Use ssh.Connect for establishing an SSH connection with various configurable options like username and password, or username and private key.

```go
client, err = ssh.Connect("example.com:22", ssh.username("root"), ssh.password("pass"))
client, err = ssh.Connect("example.com", ssh.username("admin"), ssh.privateKey("/path/to/key"))
```

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

### aiagent.GetDefaultContextProvider

Source: https://yaklang.com/api-manual/api/aiagent

Gets the default context provider for AI agents.

```APIDOC
## GetDefaultContextProvider

### Description
Gets the default context provider for AI agents.

### Definition
`GetDefaultContextProvider() ContextProvider`

### Returns
- **r1** (`ContextProvider`) - The default context provider.
```

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

### Connect to SSH Server Using Private Key

Source: https://yaklang.com/api-manual/api/ssh

Use ssh.ConnectWithKey to establish an SSH connection when you have the private key available.

```go
client, err = ssh.ConnectWithKey("example.com:22", "root", "/path/to/id_rsa")
```

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

### Create and Use an Object Pool (sync.NewPool)

Source: https://yaklang.com/api-manual/api/sync

Shows how to create an object pool using sync.NewPool() for reusing temporary objects and reducing memory allocation. The pool uses a provided function to create new objects when needed.

```go
p = sync.NewPool(func() {return make(map[string]string)})
m = p.Get() // 从 Pool 中获取，如果 Pool 中没有，则会调用传入的第一个参数函数，返回一个新的 map[string]string
m["1"] = "2"
println(m) // {"1": "2"}
// 将 m 放回 Pool 中
p.Put(m)
m2 = p.Get() // 从 Pool 中获取，实际上我们获取到的是刚 Put 进去的 m
println(m2) // {"1": "2"}

```

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

### Building and Executing a Custom HTTP Request

Source: https://yaklang.com/api-manual/buildinlibs/lib_http

Illustrates how to construct a custom HTTP request step-by-step and then execute it.

```APIDOC
## Define Any Request Step-by-Step

### Building Your Desired `http.Request`

#### Description
This section shows how to create a custom `http.Request` object with specific headers.

#### Method
HEAD

#### Endpoint
`http://baidu.com/yourpath`

#### Parameters
##### Request Headers
- `BAR` (string) - `FOO`

#### Code Example
```
req, err = http.NewRequest("HEAD", "http://baidu.com/yourpath", http.header("BAR", "FOO"))
die(err)
http.show(req) // Display request content
```

#### Request Preview
```
HEAD /yourpath HTTP/1.1
Host: baidu.com
Bar: FOO

```

### Executing Any Desired `http.Response`

#### Description
This demonstrates executing a previously constructed request and displaying the response.

#### Method
HEAD

#### Endpoint
`http://baidu.com/yourpath`

#### Parameters
##### Request Headers
- `BAR` (string) - `FOO`

#### Code Example
```
req, err = http.NewRequest("HEAD", "http://baidu.com/yourpath", http.header("BAR", "FOO"))
die(err)
http.show(req)

rsp, err = http.Do(req)
if err != nil {
    die(err)
}
http.show(rsp) // Display response information
```

#### Combined Request and Response Example
```
HEAD /yourpath HTTP/1.1
Host: baidu.com
Bar: FOO

HTTP/1.1 200 OK
Content-Length: 19825
Accept-Ranges: bytes
Cache-Control: max-age=86400
Content-Type: text/html
Date: Sat, 12 Jun 2021 12:47:43 GMT
Etag: "4d71-5bd28c3bf7800"
Expires: Sun, 13 Jun 2021 12:47:43 GMT
Last-Modified: Wed, 10 Mar 2021 06:27:44 GMT
P3p: CP=" OTI DSP COR IVA OUR IND COM "
Server: Apache
Set-Cookie: BAIDUID=378636EDCB30B5B26C7A96757C45D396:FG=1; expires=Sun, 12-Jun-22 12:47:43 GMT; max-age=31536000; path=/; domain=.baidu.com; version=1
Vary: Accept-Encoding,User-Agent

```
```

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

### Parse Float Argument

Source: https://yaklang.com/api-manual/buildinlibs/lib_cli

Parses a command-line argument as a float. Use `cli.Float(paramName)` to get the float value.

```yak
floatParam = cli.Float("floatvar")dump(floatParam)
```

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

### Parse Integer Argument

Source: https://yaklang.com/api-manual/buildinlibs/lib_cli

Parses a command-line argument as an integer. Use `cli.Int(paramName)` to get the integer value.

```yak
intParam = cli.Int("number1")dump(intParam)
```

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

### Create and Use a WaitGroup (sync.NewWaitGroup)

Source: https://yaklang.com/api-manual/api/sync

Shows how to create a WaitGroup using sync.NewWaitGroup() to wait for a collection of goroutines to finish. Each goroutine calls Done() when it completes, and Wait() blocks until all are done.

```go
wg = sync.NewWaitGroup()
for i in 5 {
wg.Add() // 增加一个任务
go func(i) {
defer wg.Done()
time.Sleep(i)
printf("任务%d 完成\n", i)
}(i)
}
wg.Wait()
println("所有任务完成")

```

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

### Parse String Argument

Source: https://yaklang.com/api-manual/buildinlibs/lib_cli

Parses a command-line argument as a string. Use `cli.String(paramName)` to get the string value.

```yak
// >  yakc clitest.yak --url https://baidu.comstrParam = cli.String("url")  dump(strParam)
```

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

### aiagent.initPrompt

Source: https://yaklang.com/api-manual/api/aiagent

Sets the initial prompt for the AI agent, used at startup to define its initial state and behavior.

```APIDOC
## initPrompt

### Description
Sets the initial prompt for the AI agent. This prompt is used when the AI agent starts up to define its initial state and behavior.

### Definition
`initPrompt(prompt string)`

### Parameters
- **prompt** (`string`) - The initial prompt text for the AI agent.
```

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

### keywords

Source: https://yaklang.com/api-manual/api/aim

Sets keywords for the AI engine. Keywords can help guide the AI's attention or relevance during its tasks.

```APIDOC
## keywords (WithKeywords)

### Description
Sets keywords for the AI engine. Keywords can help guide the AI's attention or relevance during its tasks.

### Function Signature
`keywords(kw []string) AIEngineConfigOption`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **kw** (`[]string`): A slice of strings representing the keywords to set.

### Returns
- **r1** (`AIEngineConfigOption`): An option to configure the AI engine with the specified keywords.
```

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

### withConfigInfo

Source: https://yaklang.com/api-manual/api/ssa

Sets configuration information for the SSA process. This option accepts a map of configuration key-value pairs.

```APIDOC
## withConfigInfo

### Description
Sets configuration information for the SSA process. This option accepts a map of configuration key-value pairs.

### Signature
`withConfigInfo(input map[string]any) Option`

### Parameters
#### Parameters
- **input** (map[string]any) - A map containing configuration information.
```

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

### Go WebSocket Test Server

Source: https://yaklang.com/api-manual/buildinlibs/lib_mitm

A Go program that sets up a WebSocket server on port 8884. It serves an HTML page that connects to the WebSocket and sends/receives messages. Requires `github.com/gorilla/websocket`.

```go
package main

import (
    "fmt"
    "net/http"
    "os"
    "time"

    "github.com/gorilla/websocket"
)

func main() {
    var upgrader = websocket.Upgrader{}

    f, err := os.CreateTemp("", "test-*.html")
    if err != nil {
        panic(err)
    }
    f.Write([]byte(`<!DOCTYPE html><html><head>
    <meta charset="UTF-8"/>
    <title>Sample of websocket with golang</title>
    <script src="http://apps.bdimg.com/libs/jquery/2.1.4/jquery.min.js"></script>
    <script>
        $(function() {
            var ws = new WebSocket('ws://' + window.location.host + '/ws');
            ws.onmessage = function(e) {
                $('<li>').text(event.data).appendTo($ul);
            ws.send('{"message":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}');
            };
            var $ul = $('#msg-list');
        });
    </script></head><body><ul id="msg-list"></ul></body></html>`))
    index := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        http.ServeFile(w, r, f.Name())
    })
    http.Handle("/", index)
    http.Handle("/index.html", index)
    http.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
        // msg := &RecvMessage{}
        ws, err := upgrader.Upgrade(w, r, nil)
        if err != nil {
            panic(err)
            return
        }
        defer ws.Close()

        go func() {
            for {
                _, msg, err := ws.ReadMessage()
                if err != nil {
                    panic(err)
                    return
                }
                fmt.Printf("server recv from client: %s\n", msg)
            }
        }()
        for {
            time.Sleep(time.Second)
            ws.WriteJSON(map[string]interface{}{
                "message": fmt.Sprintf("Golang Websocket Message: %v", time.Now()),
            })
        }
    })

    err = http.ListenAndServe(":8884", nil)
    if err != nil {
        panic(err)
    }}

```

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

### aiagent.initializePrompt

Source: https://yaklang.com/api-manual/api/aiagent

Sets the initial prompt for the AI agent, used at startup to define its initial state and behavior.

```APIDOC
## initializePrompt

### Description
Sets the initial prompt for the AI agent. This prompt is used when the AI agent starts up to define its initial state and behavior.

### Definition
`initializePrompt(prompt string)`

### Parameters
- **prompt** (`string`) - The initial prompt text for the AI agent.
```

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

### Connect to SSH Server Using Password

Source: https://yaklang.com/api-manual/api/ssh

Use ssh.ConnectWithPasswd for establishing an SSH connection using a username and password.

```go
client, err = ssh.ConnectWithPasswd("example.com:22", "root", "password")
```

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

### WithdrawPermission

Source: https://yaklang.com/api-manual/api/pcapx

Withdraws pcap permissions. This function is used to revoke previously granted permissions for pcap operations. An example usage is provided.

```APIDOC
## WithdrawPermission

### Description
Withdraws pcap permissions. This function is used to revoke previously granted permissions for pcap operations. An example usage is provided.

### Method
Not specified (likely internal or part of a larger operation)

### Endpoint
Not applicable

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
err := pcapx.Withdraw()
die(err)
```

### Response
#### Success Response (200)
None explicitly defined, but implies successful execution.

#### Response Example
None explicitly defined.
```

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

### context.New

Source: https://yaklang.com/api-manual/api/context

New returns an empty Context interface. It is an alias for context.Background.

```APIDOC
## New

### Description
New returns an empty Context interface. It is an alias for context.Background.

### Definition
`New() context.Context`

### Returns
- r1 (context.Context) - 

### Example
```
ctx = context.New()
```
```

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

### Build Video Knowledge Base from Omni Analysis

Source: https://yaklang.com/api-manual/api/liteforge

BuildVideoKnowledgeFromOmni leverages existing knowledge base ingestion but uses Omni's end-to-end video understanding. This function is purely incremental and independent of other BuildKnowledge functions. Requires a knowledge base name, video path, and optional Omni model presets and API keys.

```Go
ch, err := aiforge.BuildVideoKnowledgeFromOmni("xss-learn-omni-flash", "/path/to/xss-learn.mp4", aiforge.VideoOmniPresetFlash(), aiforge.WithVideoOmniAPIKey(key))
```

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

### Create and Use a Condition Variable (sync.Cond)

Source: https://yaklang.com/api-manual/api/sync

Demonstrates how to create a condition variable using sync.NewCond() and coordinate goroutines. A goroutine waits for a condition to be met, signaled by another goroutine.

```go
c = sync.NewCond()
done = false
func read(name) {
c.L.Lock()
for !done {
c.Wait()
}
println(name, " start reading")
c.L.Unlock()
}
func write(name) {
time.sleep(1)
println(name, " start writing")
c.L.Lock()
done = true
c.L.Unlock()
println(name, " wakes all")
c.Broadcast()
}
go read("reader1")
go read("reader2")
go read("reader3")
write("writer")
time.sleep(3)

```

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

### Example JSON POST Request Structure

Source: https://yaklang.com/api-manual/buildinlibs/lib_http

This shows the raw HTTP request structure when sending a JSON body with Content-Type set to application/json.

```http
POST http://baidu.com/ HTTP/1.1
Connection: close
Content-Length: 12
Content-Type: application/json
User-Agent: Go-http-client/1.1

{"test":123}
```

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

### Configure Main Dictionary for Scan

Source: https://yaklang.com/api-manual/api/subdomain

Specifies the main dictionary file or list of strings to use for subdomain brute-forcing.

```go
dict = "/tmp/dict.txt"
subdomain.Scan("example.com", subdomain.mainDict(dict))
```

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

### Parse URLs

Source: https://yaklang.com/api-manual/buildinlibs/lib_cli

Parses a command-line argument containing URLs. Use `cli.Urls(paramName)` to get the parsed URL list. It attempts to add a scheme if missing.

```yak
// --urls "leavesongs.com,10.1.3.2,https://www.baidu.com"urlParam = cli.Urls("urls")dump(urlParam)
```

```yak
// --urls2 "https://www.baidu.com"println("-----------------------------------------")urlParam = cli.Urls("urls2")dump(urlParam)/*([]string) (len=1 cap=1) { (string) (len=21) "https://www.baidu.com"}*/
```

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

### Checking String Suffix

Source: https://yaklang.com/api-manual/buildinlibs/lib_str

Demonstrates the `str.EndsWith` function to check if a string ends with a specified suffix. Note that the first example returns false as the suffix is not at the very end.

```yak
println(str.EndsWith("abcdef", "abc"))  // false
println(str.EndsWith("abcdef", "def"))  // true
```

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

### Set Documentation and Check Parameters

Source: https://yaklang.com/api-manual/buildinlibs/lib_cli

Sets documentation for the CLI, defines parameter properties like required and help messages, and checks for parameter validity. `cli.check()` must be called to enable help messages and parameter validation, otherwise the program will not exit on errors.

```yak
cli.SetDoc(`这是一个程序文档信息`)testValue = cli.String("t target", cli.setRequired(true), cli.setHelp("这是一个扫描目标，是必要参数"))boolParams = cli.Bool("b bool-params", cli.setHelp("这是一个bool值"))strValue = cli.String("testOrdinaryParam")cli.check()
println("param parsed")
```

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

### Create and Use a Concurrent-Safe Map (sync.NewMap)

Source: https://yaklang.com/api-manual/api/sync

Shows how to create a concurrent-safe map using sync.NewMap(). This map can be safely accessed and modified by multiple goroutines simultaneously.

```go
m = sync.NewMap()
go func () {
for {
m.Store("key", "value2")
}
}
for {
m.Store("key", "value")
v, ok = m.Load("key")
if ok {
println(v)
}
}

```

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

### Yak Script for WebSocket Hijacking

Source: https://yaklang.com/api-manual/buildinlibs/lib_mitm

This Yak script starts a MITM server on port 8084 that hijacks WebSocket traffic using `mitm.wscallback`. It modifies both requests and responses.

```yak
wg = sync.NewWaitGroup()
wg.Add(1)
go fn{
    defer wg.Done()
    mitm.Start(8084, mitm.wscallback(
    fn(data, isRequest){
        if isRequest {
            data = "Hijack request"
        } else {
            data = "Hijack Response"
        }
        return data
    }))
}
wg.Wait()
```

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

### exec.System / exec.SystemContext

Source: https://yaklang.com/api-manual/buildinlibs/lib_exec

These APIs are the most straightforward, similar to Python's `os.system()`. They execute a system command and return the results as bytes and an error. `exec.SystemContext` supports Context for lifecycle control.

```APIDOC
## exec.System / exec.SystemContext

### Description
Executes a system command and returns its standard output as bytes along with any error. `exec.SystemContext` provides lifecycle control via `context.Context`.

### API Signature
- `fn exec.System(var_1: string): ([]uint8, error)`
- `fn exec.SystemContext(var_1: context.Context, var_2: string): ([]uint8, error)`

### Example
```
raw, err = exec.System("ls")
die(err)
dump(raw)
```
```

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

### GetGadgetNameByFun

Source: https://yaklang.com/api-manual/api/yso

Retrieves the gadget name from a function pointer by parsing the function name. The function name is expected to be in the format 'Get _JavaObject', and the part between underscores is extracted as the gadget name.

```APIDOC
## GetGadgetNameByFun

### Description
Retrieves the gadget name from a function pointer by parsing the function name. The function name is expected to be in the format 'Get _JavaObject', and the part between underscores is extracted as the gadget name.

### Method
`GetGadgetNameByFun(i any) (string, error)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
name, err := GetGadgetNameByFun(GetCommonsBeanutils1JavaObject) // name = "CommonsBeanutils1"
```

### Response
#### Success Response (200)
- **r1** (string) - The extracted gadget name.
- **r2** (error) - Nil on success.

#### Response Example
None provided.
```

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

### Create Context with Value

Source: https://yaklang.com/api-manual/api/context

Use context.WithValue(parent, key, val) to create a Context that carries a key-value pair. Use context.Value(key) to retrieve the value.

```go
ctx = context.WithValue(context.Background(), "key", "value")
ctx.Value("key") // "value"
```

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

### Default Random String Generation

Source: https://yaklang.com/api-manual/buildinlibs/lib_fuzz

Generates a random string using the default length, which is equivalent to `{{randstr(8,8)}}`. This is the simplest way to get a random string of a standard length.

```yak
origin := "{{randstr}}"
res := fuzz.Strings(origin)
println("需要模糊渲染的字符串为：", origin)
println("渲染结果为：")
dump(res)
```

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

### ai.OpenAI

Source: https://yaklang.com/api-manual/api/ai

Initializes and returns an AI client for OpenAI. Accepts optional AI configuration options.

```APIDOC
## ai.OpenAI

### Description
Initializes and returns an AI client for OpenAI. Accepts optional AI configuration options.

### Method
`OpenAI(opts ...aispec.AIConfigOption) aispec.AIClient`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **r1** (aispec.AIClient) - An AI client instance for OpenAI.

#### Response Example
None
```

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

### toolbox.Uninstall

Source: https://yaklang.com/api-manual/api/toolbox

Uninstalls a binary using the default manager.

```APIDOC
## toolbox.Uninstall

### Description
Uninstalls a binary using the default package manager. This function is used to remove previously installed binaries.

### Method
Not applicable (SDK function)

### Signature
`Uninstall(name string) error`

### Parameters
#### name
- **name** (string) - Required - The name of the binary to uninstall.

### Returns
- **error** - An error if the uninstallation fails, otherwise nil.
```

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

### Parse Host Network Ranges

Source: https://yaklang.com/api-manual/buildinlibs/lib_cli

Parses a command-line argument containing network ranges (e.g., CIDR notation). Use `cli.Hosts(paramName)` to get the parsed host list.

```yak
// --target "192.168.1.1/24,10.1.3.2/28"netParam = cli.Hosts("target")dump(netParam)
```

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

### http.Get

Source: https://yaklang.com/api-manual/api/http

Makes a GET request to a specified URL with optional configuration options like timeout. Returns the response struct and an error. This function is deprecated and `poc.Get` should be used instead.

```APIDOC
## http.Get

### Description
Makes a GET request to a specified URL. It accepts the URL as the first argument, followed by zero or more request options for configuration, such as setting a timeout. Returns the response struct and an error.

! Deprecated, use poc.Get instead

### Method
`Get(url string, options ...http_struct.HttpOption) (*http_struct.YakHttpResponse, error)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
rsp, err = http.Get("http://www.yaklang.com", http.timeout(10))
```

### Response
#### Success Response (200)
- **r1** (`*http_struct.YakHttpResponse`) - Description not provided.

#### Response Example
None provided.
```

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

### exec.Command / exec.CommandContext

Source: https://yaklang.com/api-manual/buildinlibs/lib_exec

These APIs are the simplest and easiest to understand. They take a command string as input and return a Golang native *exec.Cmd object, with CommandContext supporting Context for lifecycle control.

```APIDOC
## exec.Command / exec.CommandContext

### Description
Provides Golang native `*exec.Cmd` objects for executing system commands. `exec.CommandContext` allows for lifecycle control using a `context.Context`.

### API Signature
- `fn exec.Command(var_1: string): (*exec.Cmd, error)`
- `fn exec.CommandContext(var_1: context.Context, var_2: string): (*exec.Cmd, error)`

### Usage
These functions return a `*exec.Cmd` object, which exposes various fields and methods for interacting with the command, such as `CombinedOutput`, `Output`, `Run`, `Start`, `StdinPipe`, `StdoutPipe`, `StderrPipe`, `String`, and `Wait`.
```

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

### Configure WebSocket Connection

Source: https://yaklang.com/api-manual/api/poc

Use the `websocket` option to enable upgrading a connection to WebSocket. The initial request must be a WebSocket handshake request. This snippet also shows proxy and callback configurations.

```go
rsp, req, err = poc.HTTP(`GET / HTTP/1.1Connection: UpgradeUpgrade: websocketSec-Websocket-Version: 13Sec-Websocket-Extensions: permessage-deflate; client_max_window_bitsHost: echo.websocket.eventsAccept-Language: zh-CN,zh;q=0.9,en;q=0.8,en-US;q=0.7Sec-Websocket-Key: L31R1As+71fwuXqhwhABuA==`,
    poc.proxy("http://127.0.0.1:7890"), poc.websocketFromServer(func(rsp, cancel) {
            dump(rsp)
        }), poc.websocketOnClient(func(c) {
            c.WriteText("123")
        }), poc.websocket(true),
)
time.Sleep(100)
```

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

### Nuclei Scan Output Example

Source: https://yaklang.com/api-manual/buildinlibs/lib_nuclei

This snippet shows the typical output when Nuclei is run within Yaklang, including loading templates, identifying vulnerabilities, and the structured result object.

```text
                       __     _     ____  __  _______/ /__  (_)    / __ 
/ / / / ___/ / _ 
/ /   / / / / /_/ / /__/ /  __/ /  /_/ /_/
__,_/
___/_/
___/_/
   v2.3.8
                projectdiscovery.io
[ERR] Could not find template 'exposed-tokens': no templates found in path[ERR] Could not find template 'helpers': no templates found in path[INF] Loading templates...[INF] [thinkphp-2-rce] ThinkPHP 2 / 3 's' Parameter RCE (@dr_set) [critical][INF] [thinkphp-5023-rce] ThinkPHP 5.0.23 RCE (@dr_set) [critical][INF] [thinkphp-5022-rce] ThinkPHP 5.0.22 RCE (@dr_set) [critical][INF] [thinkphp-509-information-disclosure] ThinkPHP 5.0.9 Information Disclosure (@dr_set) [critical][INF] Loading workflows...[INF] Using 4 rules (4 templates, 0 workflows){"templateID":"thinkphp-5023-rce","info":{"tags":"thinkphp,rce","name":"ThinkPHP 5.0.23 RCE","author":"dr_set","severity":"critical","description":"Thinkphp5 5.0(\u003c5.0.24) Remote Code Execution.","reference":"https://github.com/vulhub/vulhub/tree/0a0bc719f9a9ad5b27854e92bc4dfa17deea25b4/thinkphp/5.0.23-rce"},"type":"http","host":"http://127.0.0.1:8083","matched":"http://127.0.0.1:8083/index.php?s=captcha","ip":"127.0.0.1","timestamp":"2021-07-16T00:05:13.895207+08:00"}(*tools.PocVul)(0xc001ca8000)({ Source: (string) (len=6) "nuclei", PocName: (string) (len=17) "thinkphp-5023-rce", Target: (string) (len=21) "http://127.0.0.1:8083", IP: (string) (len=9) "127.0.0.1", Port: (int) 8083, Timestamp: (int64) 1626365113, Severity: (string) (len=8) "critical", RawJson: (string) (len=477) "{\"host\":\"http://127.0.0.1:8083\",\"info\":{\"author\":\"dr_set\",\"description\":\"Thinkphp5 5.0(\u003c5.0.24) Remote Code Execution.\",\"name\":\"ThinkPHP 5.0.23 RCE\",\"reference\":\"https://github.com/vulhub/vulhub/tree/0a0bc719f9a9ad5b27854e92bc4dfa17deea25b4/thinkphp/5.0.23-rce\",\"severity\":\"critical\",\"tags\":\"thinkphp,rce\"},\"ip\":\"127.0.0.1\",\"matched\":\"http://127.0.0.1:8083/index.php?s=captcha\",\"templateID\":\"thinkphp-5023-rce\",\"timestamp\":\"2021-07-16T00:05:13.895207+08:00\",\"type\":\"http\"}"})

```

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

### Building a Custom HTTP Request

Source: https://yaklang.com/api-manual/buildinlibs/lib_http

Construct a custom http.Request object with a specified method, URL, and headers using http.NewRequest. Use http.show to inspect the request details.

```go
req, err = http.NewRequest("HEAD", "http://baidu.com/yourpath", http.header("BAR", "FOO"))
die(err)
http.show(req)                                # 展示内容
```

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

### Parse Port Ranges

Source: https://yaklang.com/api-manual/buildinlibs/lib_cli

Parses a command-line argument containing a list or range of ports. Use `cli.Ports(paramName)` to get the parsed integer port list. This internally uses `str.ParseStringToPorts`.

```yak
// --target-port "22,3306,80,8080-8082"portParam = cli.Ports("target-port")dump(portParam)
```

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

### Simple Nuclei Scan Function Call

Source: https://yaklang.com/api-manual/buildinlibs/lib_nuclei

A straightforward way to initiate a Nuclei scan on a target directly within a Yak script. No additional setup is required if the nuclei library is available.

```go
nuclei.Scan("example.com")
```

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

### str.StartsWith

Source: https://yaklang.com/api-manual/api/str

Checks if the string `s` begins with the prefix `prefix`.

```APIDOC
## str.StartsWith

### Description
Checks if the string `s` begins with the prefix `prefix`.

### Method
Not specified (likely a function call in Yaklang)

### Endpoint
Not applicable

### Parameters
Not specified

### Request Example
Not applicable

### Response
- **bool**: true if the string starts with the prefix, false otherwise.
```

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

### context.Background

Source: https://yaklang.com/api-manual/api/context

Background returns an empty Context. This is typically used in main, initialization, or test functions as the top-level Context, and the Context for servers should not be nil if there are handlers that would otherwise have no Context.

```APIDOC
## Background

### Description
Background returns an empty Context interface.

### Definition
`Background() context.Context`

### Returns
- r1 (context.Context) - 

### Example
```
ctx = context.Background()
```
```

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

### Substring Extraction in Yak

Source: https://yaklang.com/api-manual/buildinlibs/lib_str

Shows how to extract substrings using slicing with start and end indices, similar to other programming languages. Negative indices are not directly supported; use length calculations instead.

```yak
strValue := "abcdefghijk"
subStr1 := strValue[2:6]
subStr2 := strValue[:6]
subStr3 := strValue[3:]

// subStr4 := strValue[-3:]   # 这个暂时是不支持的，如果遇到这种情况，请使用 subStr
subStr4 := strValue[len(strValue)-3:]   # 这个暂时是不支持的，如果遇到这种情况，请使用 subStr

println("subStr1: ", subStr1)
println("subStr2: ", subStr2)
println("subStr3: ", subStr3)
println("subStr4: ", subStr4)

/*OUTPUT:
subStr1:  cdef
subStr2:  abcdef
subStr3:  defghijk
subStr4:  ijk*/
```

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

### Ensure a Function Executes Only Once (sync.NewOnce)

Source: https://yaklang.com/api-manual/api/sync

Illustrates using sync.NewOnce() to guarantee that a specific function is executed exactly once, even when called multiple times concurrently. The 'Do' method handles the execution logic.

```go
o = sync.NewOnce()
for i in 10 {
o.Do(func() { println("this message will only print once") })
}

```

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

### Set Risk Type and Other Options

Source: https://yaklang.com/api-manual/api/risk

Use the `type` option to specify the risk type, with a comprehensive list of available types provided. This example also demonstrates setting title, severity, verbose title, and CVE.

```go
risk.NewRisk(addr,risk.title("CVE-2021-22145"),risk.severity("low"),risk.titleVerbose("CVE-2021-22145 Elasticsearch 敏感信息泄漏漏洞"),risk.type("info-exposure"),risk.cve("CVE-2021-22145"),)
```

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

### exec.SystemBatch

Source: https://yaklang.com/api-manual/buildinlibs/lib_exec

This function is a unique Yak feature for batch execution of system commands. It splits a command string (potentially with dynamic tags like `{{net()}}`) into multiple commands, executes them concurrently, and returns results via a callback function.

```APIDOC
## exec.SystemBatch

### Description
Executes multiple system commands concurrently. The input command string can contain dynamic tags (e.g., `{{net()}}`) which are expanded into multiple commands. Results are processed via a callback function.

### API Signature
- `fn exec.SystemBatch(var_1: string, vars: ...yaklib.poolOpt)`

### Parameters
- `var_1` (string): The command string to execute, potentially containing dynamic tags.
- `vars` (`...yaklib.poolOpt`): Options for batch execution.

#### Available `yaklib.poolOpt` Options:
- `exec.callback(var_1: func(string, []uint8)): yaklib.poolOpt` - Sets the callback function to handle results. The callback receives the command string and its output bytes.
- `exec.concurrent(var_1: int): yaklib.poolOpt` - Sets the maximum number of commands to execute concurrently.
- `exec.timeout(var_1: float64): yaklib.poolOpt` - Sets the timeout in seconds for the batch execution.

### Example
```
exec.SystemBatch(`echo {{net:(192.168.1.1/28,example.com)}}` , exec.callback(func(cmd, results){
    println(`exec: `, `results: `, codec.EncodeASCII(string(results)))
}))
```
```
Tokens:
Raw