Yao

https://github.com/wwsheng009/yao-docs
Admin
This project documents the development process, issues, and experiences encountered while building...
Tokens:192,902
Snippets:993
Trust Score:7.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Yao Amis Admin Project

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/2项目安装.md

These commands initiate the Yao Amis Admin project. Option 1 starts the project directly. Option 2 first copies a SQLite environment configuration file (`.sqlite.env`) to `.env` before starting, which is useful for database setup.

```Shell
cd yao-amis-admin
yao start
```

```Shell
cd yao-amis-admin
cp .sqlite.env .env
yao start
```

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

### Initialize Yao Application Directory

Source: https://github.com/wwsheng009/yao-docs/blob/main/knowledge-base/入门指南.md

Command line instructions to create a new Yao application directory and start the Yao server, which will guide through the initial setup process if no configuration is detected.

```bash
mkdir -p /data/app
cd /data/app
yao start
```

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

### Setup and Build Amis Editor Yao

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/2项目安装.md

This sequence of commands clones the `amis-editor-yao` project, installs its dependencies using `npm` (note: `pnpm` should not be used for this project), and provides commands for running in development mode or building for production deployment. The built output should be copied to `yao-amis-admin/public/amis-editor`.

```Shell
git clone https://github.com/wwsheng009/amis-editor-yao

# 不要使用pnpm
cd amis-editor-yao
npm install

# 开发
npm run dev

# 构造
npm run build
```

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

### Install and Run xgen Frontend Development Server

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Studio/vscode调试yao.md

These shell commands guide the installation and startup of the xgen frontend framework. It involves cloning the repository, installing dependencies using pnpm, and launching the development server, which is necessary for local debugging and interaction with the Yao backend.

```shell
git clone https://github.com/YaoApp/xgen
cd xgen
pnpm i
pnpm run dev
```

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

### Yao Application Setup Console Output

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/入门指南/上手系列/2 创建第一个Yao应用.md

The console output displayed after running `yao start`, showing the Yao Application Setup version and the local URL (e.g., `http://127.0.0.1:5099`) to access the configuration page in a web browser. Notes that the port might be random if 5099 is occupied.

```sh
---------------------------------
Yao Application Setup v0.10.3
---------------------------------
Open URL in the browser to continue:
http://127.0.0.1:5099
```

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

### Clone and Start Yao Project Template

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/AI/Vscode编辑器使用插件快速开发模型.md

This snippet provides commands to clone the `yao-init` project template, navigate into it, and start the Yao application. This template includes VSCode intelligent hints and Studio initialization scripts, streamlining the setup process for new Yao projects.

```Shell
git clone --depth 1 https://github.com/wwsheng009/yao-init.git my-yao-app

cd my-yao-app

yao start
```

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

### Example URL with QueryParam Syntax

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Query/QueryParam语法.md

An example of a GET request URL demonstrating the QueryParam syntax for filtering, selecting, and paginating data.

```bash
GET /api/user/paginate?withs=manu,mother,addresses&where.status.eq=enabled&&select=id,name,mobile,status,extra&page=1&pagesize=2
```

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

### Initialize Yao Project Directory

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/入门指南/上手系列/2 创建第一个Yao应用.md

Commands to create a new directory named `hello_world`, navigate into it, and then execute `yao start` to begin the application setup process, which opens a configuration page in the browser.

```sh
mkdir hello_world

cd hello_world

yao start
```

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

### Example Yao Application Configuration (app.yao)

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Xgen/xgen登录过程.md

A JSON example demonstrating the structure and typical values for the `app.yao` configuration file, including `xgen` version, application name, description, setup script, admin root, optional features, and menu process.

```json
{
  "xgen": "1.0",
  "name": "::Demo Application",
  "short": "::Demo",
  "description": "::Another yao application",
  "version": "1.0.1",
  "setup": "scripts.demo.Data",
  "adminRoot": "admin",
  "optional": {
    "hideNotification": true,
    "hideSetting": false,
    "neo": { "api": "/neo", "studio": true }
  },
  "menu": { "process": "flows.app.menu", "args": ["demo"] }
}
```

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

### Complete Application Directory Structure

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/2项目安装.md

This snippet illustrates the final, complete directory structure of the installed Yao application, showing the placement of `amis-sdk`, `amis-admin`, `amis-editor`, and `soy-admin` within the `public` directory.

```Shell
├── public
│   ├── amis        //amis-sdk
│   ├── amis-admin
│   ├── amis-editor //amis编辑器,目录名称不要修改
│   ├── favicon.ico
│   ├── image
│   ├── index.html
│   └── soy-admin  //soy-admin
```

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

### Develop and Build Soybean Admin Amis Yao

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/2项目安装.md

These commands navigate into the `soybean-admin-amis-yao` project and execute `pnpm` commands for development and production builds. The built files from the `dist` directory should be copied to `yao-amis-admin/public/soy-admin`.

```Shell
cd soybean-admin-amis-yao

# 开发
pnpm run dev

# 构造
pnpm run build
```

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

### Install Jest and ts-jest for TypeScript Unit Testing

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/v8go/使用typescript进行开发.md

Command to install `jest`, `ts-jest`, and `@types/jest` as development dependencies using `pnpm`. This prepares the project for writing and running unit tests in TypeScript.

```sh
pnpm i --save-dev jest ts-jest @types/jest
```

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

### Example AI Prompt for Page Generation

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/使用builder创建sui页面.md

An example prompt to guide the AI in generating a user login interface using Tailwind CSS, centered and full-screen on mobile devices.

```md
你是一个 tailwind 专家，给我生成一个用户登录界面,居中，手机显示时全屏。
```

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

### Install Core Langchain Dependencies

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/源代码/Xun/使用postgresql保存Embedding.md

Installs essential Python packages like torch, text2vect, and langchain using pip, which are fundamental for setting up a Langchain development environment.

```sh
pip install torch text2vect langchain
```

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

### Shell: Cloning Yao Development Repositories

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/neo/neo命令.md

These shell commands provide instructions for setting up the Yao development environment by cloning the `yao-neo-dev` and `yao-dev-app` repositories from GitHub. These are essential steps for developers to get started with the Yao project.

```sh
git clone https://github.com/YaoApp/yao-neo-dev.git

git clone https://github.com/YaoApp/yao-dev-app.git
```

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

### Install Node.js Project Dependencies

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/v8go/使用typescript进行开发.md

This command installs all project dependencies listed in the `package.json` file using pnpm. It ensures that all required packages, including those with aliases, are correctly downloaded and linked for the project to run.

```sh
pnpm i
```

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

### Clone Yao Amis Admin Project

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/2项目安装.md

This command clones the `yao-amis-admin` repository from GitHub, which serves as the main administration panel for the Yao application.

```Shell
git clone https://github.com/wwsheng009/yao-amis-admin.git
```

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

### Initialize Sui Project with yao start

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/使用builder创建sui页面.md

Create an empty directory, navigate into it, and run `yao start` to automatically initialize a template project and open the default port 5099 for database configuration.

```sh
mkdir sui-demo
cd sui-demo

yao start
```

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

### Defining Query Object in JsAPI

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Query/QueryDsl.md

Demonstrates how to initialize a new Query object, showing examples with default and specific database connectors. It also includes commented-out examples of basic Query methods like Get, Paginate, First, and Run.

```javascript
// var query = new Query("engine")
// query.Get({"select":["id"], "from":"user", "limit":1})
// query.Paginate({"select":["id"], "from":"user"})
// query.First({"select":["id"], "from":"user"})
// query.Run({"stmt":"show version"})
function query() {
  const query = new Query();
  //等于
  const query = new Query('default');
  //另外一个connector
  const query = new Query('pg-connect');
}
```

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

### Dynamic Table Configuration JSON Example

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Xgen/Table/Table动态配置.md

Example JSON for CUI dynamic table configuration, which only defines paths to `setting` and `search` processors. The actual table fields and layout are generated dynamically by these processors at runtime.

```JSON
{
  "name": "models",
  "action": {
    "setting": {
      "process": "scripts.model.setting"
    },
    "search": {
      "process": "scripts.model.search"
    }
  }
}
```

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

### AI Project Python Dependencies (requirements.txt)

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/源代码/Xun/使用postgresql保存Embedding.md

Lists all Python package dependencies with their exact versions required for an AI project, ensuring consistent environment setup. This file can be used with 'pip install -r requirements-ai.txt'.

```text
aiohttp==3.9.1
aiosignal==1.3.1
annotated-types==0.6.0
anyio==4.2.0
attrs==23.1.0
backoff==2.2.1
beautifulsoup4==4.12.2
blis==0.7.11
catalogue==2.0.10
certifi==2023.11.17
cffi==1.16.0
chardet==5.2.0
charset-normalizer==3.3.2
click==8.1.7
cloudpathlib==0.16.0
colorama==0.4.6
confection==0.1.4
cryptography==41.0.7
cymem==2.0.8
dataclasses-json==0.6.3
datasets==2.16.0
dill==0.3.7
distro==1.9.0
emoji==2.9.0
en-core-web-sm @ https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-3.7.1/en_core_web_sm-3.7.1-py3-none-any.whl#sha256=86cc141f63942d4b2c5fcee06630fd6f904788d2f0ab005cce45aadb8fb73889
fastapi==0.108.0
filelock==3.13.1
filetype==1.2.0
frozenlist==1.4.1
fsspec==2023.10.0
greenlet==3.0.3
grpcio==1.59.2
grpcio-health-checking==1.59.2
grpcio-tools==1.59.2
h11==0.14.0
httpcore==1.0.2
httpx==0.26.0
huggingface-hub==0.20.1
idna==3.6
jieba==0.42.1
Jinja2==3.1.2
joblib==1.3.2
jsonpatch==1.33
jsonpath-python==1.0.6
jsonpointer==2.4
langchain==0.0.353
langchain-community==0.0.7
langchain-core==0.1.4
langcodes==3.3.0
langdetect==1.0.9
langsmith==0.0.75
loguru==0.7.2
lxml==5.0.0
Markdown==3.5.1
MarkupSafe==2.1.3
marshmallow==3.20.1
mpmath==1.3.0
multidict==6.0.4
multiprocess==0.70.15
murmurhash==1.0.10
mypy-extensions==1.0.0
networkx==3.2.1
nltk==3.8.1
numpy==1.26.2
openai==1.6.1
packaging==23.2
pandas==2.1.4
pdfminer.six==20231228
preshed==3.0.9
protobuf==4.25.0
psycopg2==2.9.9
pyarrow==14.0.2
pyarrow-hotfix==0.6
pycparser==2.21
pydantic==2.5.3
pydantic_core==2.14.6
python-dateutil==2.8.2
python-iso639==2023.12.11
python-magic==0.4.27
pytz==2023.3.post1
PyYAML==6.0.1
rapidfuzz==3.6.1
regex==2023.12.25
requests==2.31.0
safetensors==0.4.1
scikit-learn==1.3.2
scipy==1.11.4
six==1.16.0
smart-open==6.4.0
sniffio==1.3.0
soupsieve==2.5
spacy==3.7.2
spacy-legacy==3.0.12
spacy-loggers==1.0.5
SQLAlchemy==2.0.24
srsly==2.4.8
starlette==0.32.0.post1
sympy==1.12
tabulate==0.9.0
tenacity==8.2.3
text2vec==1.2.9
thinc==8.2.2
threadpoolctl==3.2.0
tokenizers==0.15.0
torch==2.1.2
tqdm==4.66.1
transformers==4.36.2
typer==0.9.0
typing-inspect==0.9.0
typing_extensions==4.9.0
tzdata==2023.4
unstructured==0.11.6
unstructured-client==0.15.1
urllib3==2.1.0
uvicorn==0.25.0
wasabi==1.1.2
weasel==0.3.4
win32-setctime==1.1.0
wrapt==1.16.0
xxhash==3.4.1
yarl==1.9.4
```

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

### SUI Watch Command Live Output Example

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/sui的命令工具.md

This snippet displays the real-time output of the `yao sui watch` command, showing initial setup, continuous monitoring, and successful re-build notifications upon file changes.

```sh
[root@thinkbook14 sui-dev-app]# yao sui watch demo website
-----------------------
Public Root: /public/demo
   Template: /demo_sui_tpl/website
    Session: {}
-----------------------
Watching...
Press Ctrl+C to exit
Building...  Success (12ms)
Building...  Success (6ms)
Building...  Success (7ms)
Building...  Success (8ms)
```

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

### Amis SDK Directory Structure for Yao Amis Admin

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/2项目安装.md

After downloading and extracting the Amis SDK (sdk.tar.gz), place its contents into the `yao-amis-admin/public/amis` directory. This snippet illustrates the expected directory structure.

```Shell
├── public
│   ├── amis //sdk目录
│   │   ├── schema.json
│   │   └── sdk
│   │       ├── sdk.css
│   │       ├── sdk.js
```

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

### Clone Soybean Admin Amis Yao Project

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/2项目安装.md

This command clones the `soybean-admin-amis-yao` repository, an optional Vue-based front-end project that integrates with Amis SDK, offering deeper customization than Amis SDK alone.

```Shell
git clone https://github.com/wwsheng009/soybean-admin-amis-yao
```

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

### SUI Directory Structure Example

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/sui的命令工具.md

This example demonstrates a typical directory structure for a SUI project, including `suis` for component configurations, `data` for templates and assets, and `public` for compiled output.

```sh
├── suis
│   └── demo.sui.yao                //sui配置文件
├── data
│   └── demo_sui_tpl
│       └── website                 //template_id
│           ├── __assets            //引用assets目录下的文件需要使用语法@assets/,yao会自动编译成对应的目录
│           │   └── css
│           │       └── tailwind.min.css
│           ├── __document.html     //共用的html框架文件，比如在这里引用其它的js/css
│           └── index               //每一下页面需要使用单独的目录
│               └── index.html      //用户需要编辑的文件，html文件或是其它文件都需要与文件名同名
├── public
│   ├── demo
│   │   ├── assets                  //复制的assets目录
│   │   │   └── css
│   │   │       └── tailwind.min.css
│   │   └── index.sui               //编译输出内容,不需要修改
│   └── index.html
```

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

### Example Yao User Login Configuration (user.login.yao)

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Xgen/xgen登录过程.md

A JSON example for the `user.login.yao` configuration file, outlining the user login process, layout settings (entry point, captcha, cover, slogan, site), and the custom login script.

```json
{
  "name": "::User Login",
  "action": {
    "process": "scripts.user.Login",
    "args": [":payload"]
  },
  "layout": {
    "entry": "/x/Table/pet",
    "captcha": "yao.utils.Captcha",
    "cover": "/assets/images/login/cover.svg",
    "slogan": "::Make Your Dream With Yao App Engine",
    "site": "https://yaoapps.com/doc"
  }
}
```

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

### Example Yao Admin Login Configuration (admin.login.yao)

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Xgen/xgen登录过程.md

A JSON example for the `admin.login.yao` configuration file, detailing the admin login process, layout settings (entry point, captcha, cover, slogan, site), and third-party login options.

```json
{
  "name": "::Admin Login",
  "action": {
    "process": "yao.login.Admin",
    "args": [":payload"]
  },
  "layout": {
    "entry": "/x/Chart/dashboard",
    "captcha": "yao.utils.Captcha",
    "cover": "/assets/images/login/cover.svg",
    "slogan": "::Make Your Dream With Yao App Engine",
    "site": "https://yaoapps.com"
  },
  "thirdPartyLogin": [
    {
      "title": "微信登录",
      "href": "https://baidu.com",
      "icon": "/assets/logo_wechat.png",
      "blank": true
    },
    {
      "title": "飞书登录",
      "href": "https://google.com",
      "icon": "/assets/logo_feishu.png",
      "blank": false
    }
  ]
}
```

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

### Amis SDK Directory Structure for Soybean Admin Amis Yao

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/2项目安装.md

Similar to `yao-amis-admin`, the Amis SDK needs to be copied into the `public/amis` directory within the `soybean-admin-amis-yao` project. This snippet shows the expected structure.

```Shell
├── public
│   ├── amis //sdk目录
│   │   ├── schema.json
│   │   └── sdk
│   │       ├── sdk.css
│   │       ├── sdk.js
```

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

### Comprehensive HTTP Request Examples in JavaScript

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/处理器/网络请求.md

Provides a comprehensive set of examples for making various HTTP requests (GET, POST, PATCH, PUT, DELETE, HEAD, SEND) using the `http` module. It illustrates different parameter combinations, including sending data as payload, uploading files, and custom headers. File paths for uploads are relative to `/data/app/data/`.

```javascript
function HttpTest() {
  // Get
  http.Get('http://127.0.0.1/get?foo=bar');
  http.Get('http://127.0.0.1/get?foo=bar', { hello: 'world' });
  http.Get(
    'http://127.0.0.1/get?foo=bar',
    { hello: 'world' },
    { Auth: 'Test' }
  );

  // Post
  http.Post('http://127.0.0.1/path?foo=bar');
  http.Post('http://127.0.0.1/path?foo=bar', { name: 'Lucy' });
  http.Post('http://127.0.0.1/path?foo=bar', { name: 'Lucy' }, null, {
    hello: 'world'
  });
  http.Post(
    'http://172.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    null,
    { hello: 'world' },
    { Auth: 'Test' }
  );

  // Post File via payload 文件路径为相对路径 相对地址, 示例: `/text/foo.txt`, 绝对路径为: `/data/app/data/text/foo.txt`。
  http.Post('http://127.0.0.1/path?foo=bar', '/path/root/file');

  // Post File via files
  http.Post(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { f1: '/path/root/f1', f2: '/path/root/f2' }
  );

  // Patch
  http.Patch('http://127.0.0.1/path?foo=bar');
  http.Patch('http://127.0.0.1/path?foo=bar', { name: 'Lucy' });
  http.Patch(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' }
  );
  http.Patch(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' },
    { Auth: 'Test' }
  );

  // Put
  http.Put('http://127.0.0.1/path?foo=bar');
  http.Put('http://127.0.0.1/path?foo=bar', { name: 'Lucy' });
  http.Put(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' }
  );
  http.Put(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' },
    { Auth: 'Test' }
  );

  // Delete
  http.Delete('http://127.0.0.1/path?foo=bar');
  http.Delete('http://127.0.0.1/path?foo=bar', { name: 'Lucy' });
  http.Delete(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' }
  );
  http.Delete(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' },
    { Auth: 'Test' }
  );

  // Head
  http.Head('http://127.0.0.1/path?foo=bar');
  http.Head('http://127.0.0.1/path?foo=bar', { name: 'Lucy' });
  http.Head(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' }
  );
  http.Head(
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' },
    { Auth: 'Test' }
  );

  // Send
  http.Send('POST', 'http://127.0.0.1/path?foo=bar');
  http.Send('POST', 'http://127.0.0.1/path?foo=bar', { name: 'Lucy' });
  http.Send(
    'POST',
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' }
  );
  http.Send(
    'POST',
    'http://127.0.0.1/path?foo=bar',
    { name: 'Lucy' },
    { hello: 'world' },
    { Auth: 'Test' }
  );
}
```

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

### Start Yao Application

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/AI/Vscode编辑器使用插件快速开发模型.md

If the Yao application is not currently running, use this command to initiate its startup. Once started, the application will be accessible via a web browser, typically at the specified local address.

```Shell
yao start
```

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

### Query DSL Example (for Contrast)

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Query/QueryParam语法.md

An example of a Query DSL object, provided to highlight the differences in syntax compared to QueryParam, particularly in where conditions.

```json
{
  "comment": "统计各行业最高分",
  "select": ["industries@", "city", ":MAX(score) as high_score"],
  "from": "service",
  "wheres": [
    { ":created_at": "创建时间", ">=": "2021-01-01" },
    { ":created_at": "创建时间", "<=": "{'2021-12-31'}" },
    { ":updated_at": "更新时间", "is": "null" },
    {
      "wheres": [
        { ":type": "类型", "=": 1 },
        { "or:type": "或类型", "=": 2 }
      ]
    }
  ],
  "orders": "high_score desc",
  "limit": 100,
  "groups": ["industries@", "city"]
}
```

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

### Install and Build Amis Editor for Yao-Admin

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/Admin-App/教程/6页面编辑器.md

Instructions for installing dependencies and building the Amis editor project. It specifies using npm and warns against yarn or pnpm. Includes commands for development and production builds.

```sh
npm i

# 开发
npm run dev

# 发布
npm run build
```

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

### Install pnpm globally

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/sui项目中使用flowbite.md

Instructions to install the pnpm package manager globally using npm.

```sh
npm install -g pnpm
```

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

### Yao API GET Request Definition Example

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/API/定义YAO API.md

Provides an example of defining a GET request in Yao, including path, method, process, input parameters, and output format.

```json
{
  "path": "/data/:id",
  "method": "GET",
  "process": "scripts.data.getDataById",
  "in": ["$param.id"],
  "out": {
    "status": 200,
    "type": "application/json"
  }
}
```

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

### Download and Extract Go 1.23.4

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/源代码/源码编译/编译yao源代码.md

This sequence of commands downloads the Go 1.23.4 binary distribution for Linux AMD64 and extracts it to a specified directory. It prepares the Go environment by placing the Go SDK in the designated location for further setup.

```Shell
mkdir -p $HOME/go/go1.23.4

cd $HOME/go

wget https://go.dev/dl/go1.23.4.linux-amd64.tar.gz

tar -xvf go1.23.4.linux-amd64.tar.gz -C $HOME/go/go1.23.4
```

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

### Start Yao Backend Service

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/sui介绍.md

This command initiates the Yao backend service, which then serves the compiled SUI pages. The service reads the compiled templates based on routes, calls associated processors to fetch dynamic data, and renders the final HTML page to the client.

```Shell
yao start
```

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

### Prepare v8go Library with Git LFS

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/源代码/源码编译/编译yao源代码.md

This sequence of commands prepares the v8go library, which often includes large binary files managed by Git LFS. It installs Git LFS, fetches the large files, checks out the repository, and then unzips the `libv8.a.zip` file if present, ensuring the necessary V8 library is available for compilation.

```Shell
cd v8go

sudo apt-get install git-lfs

git lfs fetch

git checkout .

# 如果存在 zip 文件，需要解压
cd deps/linux_x86_64
unzip libv8.a.zip
```

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

### Static Table Configuration JSON Example

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Xgen/Table/Table动态配置.md

Example JSON for CUI static table configuration, defining fields (filter, table) and layout (header, filter, table) directly. It includes action processors and specifies column properties.

```JSON
{
  "name": "models",
  "action": {
    "search": {
      "process": "scripts.model.search"
    }
  },
  "fields": {
    "filter": {
      "模型": {
        "bind": "where.model.eq",
        "edit": {
          "props": {
            "options": [],
            "placeholder": "please select 模型"
          },
          "type": "Select"
        }
      }
    },
    "table": {
      "模型": {
        "bind": "model",
        "view": {
          "props": {
            "options": [],
            "placeholder": "please select 模型"
          },
          "type": "Text"
        }
      }
    }
  },
  "layout": {
    "name": "模型",
    "header": {
      "actions": [],
      "preset": {}
    },
    "filter": {
      "actions": [],
      "columns": [
        {
          "name": "模型"
        }
      ]
    },
    "primary": "model",
    "table": {
      "columns": [
        {
          "name": "模型",
          "width": 160
        }
      ],
      "operation": {
        "hide": true,
        "actions": []
      }
    }
  }
}
```

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

### JavaScript Backend Script Example

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/sui模板关联数据定义.md

This JavaScript snippet provides a basic example of a backend script function. It's invoked when a processor name starts with '@' and a corresponding '.backend.ts' or '.backend.js' file exists, having higher priority than general processors.

```javascript
function myscript(args) {}
```

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

### Compile and Verify Yao Application

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/源代码/源码编译/编译yao源代码.md

This snippet navigates into the yao directory and initiates the compilation process using `make debug1`. After compilation, it verifies the installation by checking the Yao application's version, confirming a successful build and readiness for use.

```Shell
cd yao && make debug1

yao version
```

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

### Install Project Dependencies and Copy Assets

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/SUI模板引擎.md

This bash snippet provides commands to install project dependencies using pnpm and then copy the flowbite.min.js file from node_modules to the __assets/js directory. This ensures necessary frontend assets are available for the application.

```bash
pnpm install
cp node_modules/flowbite/dist/flowbite.min.js __assets/js/flowbite.min.js
```

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

### For Flow Control Example for Numerical Range Iteration

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Flow/流程控制.md

Illustrates the 'For' flow control, designed for iterating over a numerical range. It takes a start value (inclusive), an end value (exclusive), and a processor configuration. The example iterates from 0 to 4, passing the current index as both '::key' and '::value' to a sub-processor. This is useful for fixed-count tasks, generating specified numerical sequences, or executing operations a specific number of times.

```json
{
  "label": "For流程控制示例",
  "version": "1.0.0",
  "description": "演示For流程控制的使用方法",
  "nodes": [
    {
      "name": "数值遍历",
      "process": "xiang.flow.For",
      "args": [
        0,
        5,
        {
          "process": "flows.处理数值",
          "args": ["::key", "::value"]
        }
      ]
    }
  ],
  "output": {
    "示例说明": "For流程控制会遍历从0到4（不包含5）的数值",
    "遍历变量": {
      "key": "当前遍历的索引值，如0,1,2,3,4",
      "value": "与key相同，值为当前遍历的索引值"
    }
  }
}
```

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

### Build and Test Golang gRPC Plugin

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Plugin/golang grpc 插件模板.md

Shell commands to navigate to the plugin directory, initialize the Go module, download dependencies, build the plugin as a shared library (`.so` for Linux/macOS, `.dll` for Windows), set execution permissions, and finally test the plugin's functionality using `yao run`.

```Shell
cd plugins/demo

go mod init main

go mod tidy

go build -o ../demo.so .

# go build -o ../demo.dll .

chmod +x ../demo.so

cd ../../

yao run plugins.demo.Hello "World"
```

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

### Yao Initial Project Directory Structure

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/入门指南/上手系列/2 创建第一个Yao应用.md

A comprehensive tree view illustrating the default directory and file structure automatically generated by Yao after project initialization. Each top-level directory is briefly described, highlighting where different types of configuration files (e.g., APIs, models, scripts) are located and the recommended file extensions.

```sh
├── aigcs                                       <= chatgpt aigc接口
│   └── translate.ai.yml
├── apis                                        <= 外部api配置
│   └── aigc.http.yao
├── app.yao                                     <= yao应用配置
├── charts                                      <= 图表配置
│   └── pet.chart.yao
├── connectors                                  <= 连接器
│   └── openai
│       ├── gpt-3_5-turbo.conn.yao
│       ├── text-embedding-ada-002.conn.yao
│       └── whisper-1.conn.yao
├── dashboards                                  <= 大屏配置
│   └── kanban.dash.yao
├── data                                        <= 应用数据
├── db                                          <= 数据库
│   └── yao.db
├── .env                                        <= 环境变量配置
├── flows                                       <= flows处理器
│   ├── app
│   │   └── menu.flow.yao
│   └── stat
│       └── data.flow.yao
├── forms                                       <= 表单配置
│   ├── admin
│   │   └── user.form.yao
│   └── demo
│       └── pet.form.yao
├── icons                                       <= 应用图标
│   ├── app.icns
│   ├── app.ico
│   └── app.png
├── langs                                       <= 多语言
│   ├── zh-cn
│   │   └── global.yml
│   └── zh-hk
│       └── global.yml
├── LICENSE
├── logins                                      <= 登录处理器
│   ├── admin.login.yao
│   └── user.login.yao
├── logs                                        <= 日志
│   └── application.log
├── models                                      <= 模型配置
│   ├── admin
│   │   └── user.mod.yao                        <= 应用默认的用户配置表
│   └── pet.mod.yao
├── neo                                         <= neo助手/neo命令配置
│   └── neo.yml                                 <= neo助手配置
├── public                                      <= 网站public目录
│   ├── demo
│   │   └── pet.html
│   └── index.html                              <= 自定义网站入口
├── README.md
├── scripts                                     <= js脚本处理器
│   ├── dash.js
│   ├── guard.js
│   ├── setup.js
│   └── stat.js
├── services                                    <= 云函数
│   └── neo.js                                  <= neo脚手默认服务处理器
└── tables                                      <= 表格配置
    ├── admin
    │   └── user.tab.yao
    └── demo
        └── pet.tab.yao
```

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

### Yao/SUI HTTP Request Utility (TypeScript)

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/AI/SUI 提示词.md

Provides examples of using the `yao` object for making various HTTP requests, including GET, POST, and file downloads, with parameters and headers.

```typescript
const yao = new Yao();
// GET请求
const result = await yao.Get('/api/path', params, headers);
// POST请求
const result = await yao.Post('/api/path', { key: 'value' }, params, headers);
// 文件下载
await yao.Download('/api/path', params, filename, headers);
```

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

### Yao Global Utility Object Usage Examples

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/sui编译文件自动插入的内容.md

Illustrates practical usage of the `Yao` global utility object. Examples cover creating an instance, retrieving and setting authentication tokens, managing browser cookies, serializing data for URL parameters, and performing various HTTP operations like GET, POST, and file downloads.

```js
// 创建一个新的Yao实例
const yao = new Yao();
// 获取当前的Token
const token = yao.Token();
// 获取指定名称的Cookie值
const cookie = yao.Cookie('cookieName');
// 设置Cookie,有效期7天
yao.SetCookie('cookieName', 'cookieValue', 7);
// 删除指定名称的Cookie
yao.DeleteCookie('cookieName');
// 将对象序列化为查询字符串
const data = yao.Serialize({ key: 'value' });

// 发送GET请求到指定路径
const rest = await yao.Get('/api/path', params, headers);
// 发送POST请求到指定路径
const rest = await yao.Post('/api/path', { key: 'value' }, params, headers);
// savefile filename to save
// 下载文件到指定路径
await yao.Download('/api/path', params, savefile, headers);
```

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

### Comprehensive Plan Usage Example

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/Plan/计划组件.md

This example demonstrates the full lifecycle of a Plan, including its creation, subscription to various events (task start/completion, shared space changes), adding tasks with different execution orders, running the plan, and releasing resources. It also illustrates how tasks interact with the shared space and report their status.

```TypeScript
import { Plan, time } from '@yao/runtime';

function Test() {
  const namespace = 'scripts.runtime.api.plan';

  //same id with same namespace,will be the same plan
  //同一个id,多次new Plan,会返回同一个plan
  const plan = new Plan('test-plan');
  // 订阅任务的变化
  plan.Subscribe('TaskStarted', `${namespace}.TaskStarted`, 'foo');
  plan.Subscribe('TaskCompleted', `${namespace}.TaskCompleted`, 'foo');
  // 订阅共享空间的变化
  plan.Subscribe('some-key', `${namespace}.SomeKey`, 'bar');

  plan.Add('task-1', 1, `${namespace}.Task1`, 'foo1');
  plan.Add('task-2', 1, `${namespace}.Task2`, 'foo2');
  plan.Add('task-3', 2, `${namespace}.Task3`, 'foo3');
  plan.Add('task-4', 2, `${namespace}.Task4`, 'foo4');
  // 运行计划
  plan.Run();
  // 释放计划,资源，也会触发subscribe事件。
  plan.Release();
  return 'Done';
}

function Task1(plan_id: string, task_id: string, foo: string) {
  const plan = new Plan(plan_id);

  // 更新共享数据，will trigger the SomeKey signal
  plan.Set('some-key', `foo-${foo}`);
  time.Sleep(200);
  const ts = new Date().getTime();
  return ts;
}

function Task2(plan_id: string, task_id: string, foo: string) {
  time.Sleep(300);
  const ts = new Date().getTime();
  return ts;
}

function Task3(plan_id: string, task_id: string, foo: string) {
  const plan = new Plan(plan_id);
  const some = plan.Get('some-key');

  // 更新共享数据
  plan.Set('some-key', `bar-${foo}`);
  time.Sleep(400);
  const ts = new Date().getTime();
  return { ts: ts, shared: some };
}

function Task4(plan_id: string, task_id: string, foo: string) {
  const plan = new Plan(plan_id);
  time.Sleep(500);
  const some = plan.Get('some-key');
  const ts = new Date().getTime();
  return { ts: ts, shared: some };
}

function SomeKey(plan_id: string, key: string, data: any, foo: string) {
  const ts = new Date().getTime();
  console.log(`SomeKey ${plan_id} ${key} ${JSON.stringify(data)} ${foo} ${ts}`);
  console.log(plan.Status());
}

function TaskStarted(plan_id: string, key: string, data: any, foo: string) {
  const ts = new Date().getTime();
  console.log(
    `TaskStarted ${plan_id} ${key} ${JSON.stringify(data)} ${foo} ${ts}`
  );
}

function TaskCompleted(plan_id: string, key: string, data: any, foo: string) {
  const ts = new Date().getTime();
  console.log(
    `TaskCompleted ${plan_id} ${key} ${JSON.stringify(data)} ${foo} ${ts}`
  );
}
```

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

### Run Yao Processor from Command Line

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/入门指南/基础/使用处理器.md

Demonstrates how to execute a Yao processor directly from the command line using the `yao run` command, passing arguments as needed.

```bash
yao run models.product.Paginate '::{}' 1 2
```

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

### SUI Build Output Example

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/YaoDSL/SUI/sui的命令工具.md

This snippet illustrates the console output after a successful SUI build operation, showing the public root, template path, and build status.

```bash
-----------------------
Public Root: /public/
   Template: /templates/default
    Session: {}
-----------------------
Build succeeded for production in 9ms
```

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

### Yao Model Column Field Types Reference

Source: https://github.com/wwsheng009/yao-docs/blob/main/docs/AI/Yao模型提示词.md

Comprehensive reference for various data types supported for columns in a Yao model, categorized by string, numeric, date/time, and other types, with examples for configuration.

```APIDOC
FieldTypes:
  StringTypes:
    string:
      description: Variable-length string (default 200)
      example: {"type": "string", "length": 100}
    char:
      description: Fixed-length string
      example: {"type": "char", "length": 2}
    text:
      description: Plain text (65KB)
      example: {"type": "text"}
    mediumText:
      description: Medium text (16MB)
      example: {"type": "mediumText"}
    longText:
      description: Long text (4GB)
      example: {"type": "longText"}
  NumericTypes:
    tinyInteger:
      description: -128 to 127
      example: {"type": "tinyInteger"}
    integer:
      description: -2B to 2B
      example: {"type": "integer"}
    bigInteger:
      description: -9E to 9E
      example: {"type": "bigInteger"}
    decimal:
      description: High-precision decimal
      example: {"type": "decimal", "precision": 10, "scale": 2}
  DateTimeTypes:
    date:
      description: Date (YYYY-MM-DD)
      example: {"type": "date"}
    datetime:
      description: Date and time
      example: {"type": "datetime"}
    timestamp:
      description: Timestamp
      example: {"type": "timestamp"}
  OtherTypes:
    boolean:
      description: Boolean value
      example: {"type": "boolean"}
    json:
      description: JSON data
      example: {"type": "json"}
    uuid:
      description: Unique identifier
      example: {"type": "uuid"}
    enum:
      description: Enumeration type
      example: {"type": "enum", "option": ["A", "B"]}
```
Tokens:
Raw