MakeScript 是一个可以将脚本执行集成到 Makeflow ，或者通过 API 调用执行脚本的工具。
在开始之前，你需要先安装 NodeJs 和 yarn（或 npm）。然后使用 yarn 或 npm 在全局安装 MakeScript 的 CLI 工具。
yarn global add @makeflow/makescript安装完成后在终端执行 makescript 命令。在第一个问题中输入 y；在第二个问题中输入当前仓库的 git 地址 (https://github.com/makeflow/makescript.git) 后回车；在第三个问题中直接回车。
然后等待片刻，看到控制台输出了 Successfully to registered as "default" 字样后即代表 MakeScript 启动成功。（因为会从 GitHub clone 仓库，如果网络环境不好可能会等待较长时间）。
MakeScript 启动成功后，在浏览器中访问 http://localhost:8900 即可进入 MakeScript 的管理界面。第一次进入时会要求输入一个密码进行初始化，以后再次进入需要提供初始化时输入的密码进行身份验证。
输入密码初始化后，在管理界面中的 "Token 管理" 界面中新建一个 Token 并复制。然后使用 HTTP 请求工具发起如下 HTTP 请求：
POST http://localhost:8901/api/script/default/echo-message/enqueue
Content-Type: application/json
Authorization: Token the-token-created-before
{
"parameters": {
"message": "Hello"
}
}如果操作成功，该请求将会响应 {id: record-id}。
回到管理界面进入 “脚本执行” 界面，将会记录列表里看到刚刚的请求。在列表里点击该记录，然后点击右下角的 按钮，在弹出的对话框中输入密码 abc123 后点击 “执行” 按钮。
执行后将会在该界面看到执行结果及脚本输出等信息：
在项目的早期阶段，可能会因为业务需要或客户需求而进行一些分散零碎而且很细小的功能需求，但是又不属于产品的功能或暂未安排到日程中。比如客户咨询客服修改密码、客户要求删除账号等。
可能这些需求只需要简单地改变数据库中的一个字段、或是执行一段简单的脚本。但这些操作都不适合非技术人员去操作，但是为这些小需求都提供一个非技术人员能操作的界面成本又太高。
于是 MakeScript 让技术人员只关注脚本中业务逻辑，而 MakeScript 负责去提供一个用户友好的操作界面。且搭配 Makeflow 的流程系统，还能轻松地与其他工作流进行有机结合。
MakeScript 以 npm 包的形式提供了一个 CLI，你可以通过 yarn 或 npm 来将 MakeScript 安装到全局：
- yarn:
yarn global add @makeflow/makescript- npm:
npm install @makeflow/makescript --global安装 MakeScript 后，直接在控制台中输入 makescript 命令即可启动。首次启动时会要求输入一些必要信息：
-
首先会询问是否启用默认 Agent，输入
y或直接回车为启用，输入n为不启用：
如果需要在启动 MakeScript 的本机上执行脚本，则可以启用默认 Agent。如果当前机器仅作为 API 端，或仅与 Makeflow 进行桥接，而执具体的脚本会在其他机器上执行，则可以不启用默认节点。 -
如果启用了默认 Agent，则会提示输入 脚本仓库 的地址，MakeScript 在每次启动时将会同步该仓库：
输入一个脚本仓库的地址并回车后，MakeScript 将会将该仓库的脚本同步到本地，以方便后续执行。该地址可以是一个 HTTPS 地址 或 SSH 地址，但请确保有对该仓库的访问权限。 -
如果启用了默认节点，且在上一步中输入了脚本仓库地址。则会提示输入脚本子路径，该路径为脚本定义文件
makescript.json或makescript.js在脚本仓库中的相对路径。如果脚本定义文件在脚本仓库的根目录中，可直接回车。
MakeScript 提供了一个 Web 管理界面，启动 MakeScript 后使用浏览器进入 http://localhost:8900 来访问。第一次访问时会提示输入密码进行初始化：
输入密码成功初始化后，即会进入 MakeScript 的管理主界面。该界面中，包含了 脚本执行、Token 管理、Makeflow 集成 和 管理节点 四个选项：
脚本执行: 在脚本执行界面中，可以查看历史执行记录、执行需要手动执行的脚本、查看所有可执行的脚本。Token 管理: 在Token 管理界面中，可以创建和停用 Token。Makeflow 集成: 在Makeflow 集成界面中，可以登录到 Makeflow 后将脚本列表以超级应用的形式发布到 Makeflow 。节点管理: 在节点管理界面中，可以查看节点注册命令、节点注册链接和已注册的节点及所有节点的脚本数量。
在 MakeScript 初始化后，可以通过编辑配置文件来修改 MakeScript 的一些配置。该配置文件的路径默认在 ~/.makescript/makescript.json。其类型定义文件如下：
export interface JSONConfigFile {
/**
* 可让外部访问到的地址，默认为 http://localhost:8900
*/
url: string;
listen: {
/**
* MakeScript 服务监听到的 host，默认为 localhost
*/
host: string;
/**
* MakeScript 服务监听到的端口，默认为 8900
*/
port: number;
};
agent: {
/**
* 提供给 Agent 验证身份的 Token
*/
token: string;
};
/**
* Makeflow 相关配置
*/
makeflow: {
/**
* Makeflow 的地址，默认为 https://www.makeflow.com
*/
url: string;
powerApp: {
name: string;
displayName: string;
description: string;
};
};
}MakeScript 默认会在本地执行脚本（启用了默认 Agent 时），但在实际情况中有可能会在不同的环境中有不同的脚本要执行。而分别管理各个服务器会比较麻烦，所以 MakeScript 提供了只用于执行脚本的 Agent。不同的 Agent 可以连接到一个 MakeScript 主节点，脚本的管理和集成等在 MakeScript 主节点上进行统一操作，各个 Agent 只负责执行脚本并返回结果。
因为 MakeScript 的 Agent 没有管理界面、与 Makeflow 集成、提供 API 等功能，比 MakeScript 本体更轻量，所以单独提供了一个程序用于启动节点。与 MakeScript 一致，节点工具也以 npm 包的形式提供，可以通过 yarn 或 npm 来进行安装：
- yarn:
yarn global add @makeflow/makescript-agent- npm:
npm install @makeflow/makescript-agent --global在目标机器上成功安装 Agent 工具后，在控制台执行 makescript-agent 并在控制台输入一些必要的信息进行初始化后，即可启动一个 Agent 并连接到 MakeScript 主节点。在第一次执行该命令时，需要输入一些必要的信息以初始化：
- 首先需要提供的是 MakeScript 祝节点节点提供的节点注册链接，该链接在 MakeScript 管理界面的 “节点管理” 界面里可以查看到并复制：
也可以在节点管理界面中点击 "节点加入命令" 复制该命令后，直接使用该命令初始化 Agent。这样会在初始化时跳过这一步。
-
需要提供的第二个信息是一个名称空间，该名称空间用于区分不同的 Agent，不同 Agent 的名称空间不能重复。
-
需要提供的第三个信息是一个脚本仓库的地址，这个脚本仓库中的脚本均可以在该 Agent 上执行。
-
需要提供的第四个信息是一个脚本的子路径，这个路径为脚本定义文件
makescript.json在脚本仓库中的位置。如果脚本定义文件在脚本仓库根目录中，可直接回车。
在 MakeScript 的 Agent 初始化后，可以通过编辑配置文件来修改 MakeScript Agent 的一些配置。该配置文件的路径默认在 ~/.makescript/agent/makescript-agent.json。其类型定义文件如下：
export interface JSONConfigFile {
/**
* MakeScript Agent 注册到 MakeScript 时的名称
*/
name: string;
server: {
/**
* 包含 Token 信息的 MakeScript 地址，类似 https://example.com/token
*/
url: string;
};
scripts: {
/**
* 脚本仓库的地址
*/
git: string;
/**
* 脚本定义文件所在目录
*/
dir?: string;
};
/**
* Agent 要使用的网络代理
*/
proxy?: string | undefined;
}脚本仓库里包含了一系列将要执行的脚本以及根目录或子目录下一个名为 makescript.json 或 makescript.js 的定义文件。该定义文件中定义脚本列表、执行密码、脚本参数、脚本和脚本钩子等信息。可以参考本项目根目录中的 makescript.js 文件和 example-scripts/makescript.json 文件。在编写脚本定义时，可以使用 makescript check-definition 命令来检测该文件是否符合定义要求。该定义文件可以有如下属性：
可选属性，hooks 属性中可以定义一系列 hook，在发生特定事件时，将会执行定义里的命令。目前可用的钩子有：
install: 初始化脚本仓库时将会执行，可以用于安装脚本仓库所需依赖postscript: 当有脚本被触发时将会执行，可用于通知管理员手动执行脚本
示例：
{
"hooks": {
"install": "yarn",
"postscript": "sh ./notify.sh"
}
}hooks 中与脚本相关的 hook（postscript）在执行时，可以使用以下环境变量：
SCRIPT_NAME: 当前脚本名NAMESPACE: 当前 Agent 的名称空间
可选属性，password 属性可以提供一个密码哈希值，提供了该值后，执行该脚本仓库中的所有脚本时均需要输入确认密码。该哈希值可以通过 makescript generate-hash 生成。
示例：
{
"password": "$2b$10$Qqz.Lqa1WwtvdFXgHM3pAu/sbzwpKo94zUCYwMiipDJZq.67QB/wW"
}必选属性，scripts 属性接受一个数组，其定义了所有可供执行的脚本，以及这些脚本的需要接受的参数。除了通用属性外，当脚本定义的 type 不同时，也会有一些额外的属性，在后面有单独的介绍。
示例：
{
"scripts": [
{
"displayName": "Echo Message",
"name": "echo-message",
"type": "node",
"module": "example-scripts/echo-message.js",
"parameters": ["message"],
"manual": false
}
]
}scripts 中的单个元素定义如下：
type ScriptDefinition = {
/**
* 脚本的展示名称
*/
displayName?: string;
/**
* 脚本的唯一识别名称，在同一个脚本仓库中需唯一
*/
name: string;
/**
* 脚本类型，可选值有 `process`、`node`、`shell`、`sqlite`
*/
type: string;
/**
* 执行该脚本时是否需手动确认
*/
manual?: boolean;
/**
* 脚本的参数列表，接受参数定义或字符串数组
*
* 参数的传递方式根据不同类型的脚本而不同，具体请查看不同类型脚本的相关介绍
*/
parameters?: (
| {
/**
* 参数唯一识别名称，在同一个脚本的定义里需唯一
*/
name: string;
/**
* 参数的展示名称
*/
displayName?: string;
/**
* 是否为必选参数
*/
required?: boolean;
/**
* 要创建 MakeScript 的表单类型
*/
field?:
| string
| {
type: string;
data?: unknown;
};
}
| string
)[];
/**
* 单个脚本的执行密码的哈希值，该属性出现时将会覆盖同名全局属性
*/
password?: string;
/**
* 单个脚本的钩子，该属性下的子属性出现时会覆盖全局属性中的对应子属性
*/
hooks?: {
postscript?: string;
};
};scripts[]#type 为 process 时，必须提供 scripts[]#command 属性指定一个个执行文件。
该类型的脚本的参数会通过环境变量进行传递。
scripts[]#type 为 node 时，必须提供 scripts[]#module 指定一个 js 文件。
该类型的脚本的参数会通过环境变量进行传递。
scripts[]#type 为 shell 时，必须提供 scripts[]#command 指定一个命令。
该类型的脚本的参数会通过环境变量进行传递。
scripts[]#type 为 sqlite 时，脚本定义里有一下的额外属性：
file: SQL 文件路径db: 为一个 sqlite 数据库文件的地址或结构为{path: string; password: string}的对象
该类型的脚本的参数会通过 SQL 参数传递，在 SQL 文件中使用 $parameterName 的形式来使用。
可以使用脚本仓库的定义中的 hooks#postscript 或 scripts[]#hooks#postscript 属性来在脚本被触发时执行一个脚本，再结合 TriggerScript 在脚本中使用 curl 等工具调用一个通知请求。
可以使用脚本仓库的定义中的 password 或 scripts[]#password 结合 makescript generate-hash 命令来实现。
- 在 MakeScript 的 Web 管理界面中，点击首页中的 "Makeflow 集成" 按钮，然后输入 Makeflow 的用户名与密码进行登录。
- 登录成功后点击 "发布 Power App " 按钮后点击对话框中的 "确认发布" 按钮将应用发布或更新到 Makeflow
- 到 Makeflow 的应用商店中安装该应用
- 在 Makeflow 的流程中使用 MakeScript 应用提供的超级流程项
如出于安全原因等，需要仅在内网环境内能管理 MakeScript ，但又需要与公网的 Makeflow 进行集成。需要让运行 MakeScript 的服务器能访问 Makeflow，且用 Nginx 等反向代理工具，将 MakeScript 的 /api/makeflow/* API 暴露到公网供 Makeflow 访问。
MakeScript (Agent) 是通过一个工作目录来确定如何启动 MakeScript (Agent) 的，如果直接执行 makescript (makescript-agent) 命令，则会默认使用 ~/.makescript (~/.makescript/agent) 作为工作目录。可以通过 --dir <dir> (-d <dir>) 参数来手动指定工作目录，而达到在同一台服务器上启动多个独立的 MakeScript (Agent)。
# 在默认工作目录 (~/.config/makescript) 中启动 MakeScript
makescript
# 以 ~/.makescript/a-agent 为工作目录启动一个 MakeScript Agent
makescript-agent --dir ~/.makescript/a-agent
# 以 ~/.makescript/another-agent 为工作目录启动另一个 MakeScript Agent
makescript-agent -d ~/.makescript/another-agent可以将脚本的定义放在不同的目录中，然后在初始化 Agent 时输入定义文件所在目录或使用 Agent 配置文件 中的 scripts#dir 来指定脚本定义存放位置。
MIT License.