Node.js的SuiteCloud CLI使用指南

709 阅读3分钟

一、先决条件

1、必需软件:

  • Node.js 14.16.0 LTS 版本
  • Oracle JDK 11 版本

2、环境开启SDF功能:

进入 Setup > Company > Enable Features,在 SuiteCloud tab页启用以下几个功能:

  • Client SuiteScript
  • Server SuiteScript
  • Web Services (SuiteTalk)
  • SuiteCloud Development Framework

3、开发者权限(如有管理员权限可忽略)

  • Lists > Documents and Files
  • Setup > SuiteScript
  • Setup > SuiteApp
  • Setup > Web
  • Setup > Bulk

可在NetSuite 帮助中心阅读完整的先决条件列表。

二、安装Node.js 的CLI

输入npm install -g @oracle/suitecloud-clia 安装Node.js的CLI,出现SuiteCloud SDK dependencies downloaded successfully即表示安装成功 Image.png

三、CLI语法

Node.js 的 CLI 使用以下语法: suitecloud <command> <option> <argument>

命令描述
account:manageauth管理所有项目的身份验证 ID (authid)。
account:savetoken保存您之前在 NetSuite 中颁发的 TBA 令牌。
account:setup设置一个帐户以用于 Node.js 的 SuiteCloud CLI。
config:proxy配置代理服务器。
file:import将文件从帐户导入到您的帐户自定义项目。
file:list列出您帐户的文件柜中的文件。
file:upload将文件从您的项目上传到帐户。
object:import将自定义对象从帐户导入您的 SuiteCloud 项目。
object:list列出在帐户中部署的自定义对象。
object:update用帐户中的自定义对象覆盖项目中的自定义对象。
project:adddependencies将缺少的依赖项添加到清单文件。
project:create创建 SuiteCloud 项目,SuiteApp 或帐户自定义项目 (ACP)。
project:deploy部署包含项目的文件夹。
project:package从您的项目生成 ZIP 文件,遵守 deploy.xml 文件中指定的结构,并应用本地验证。
project:validate验证包含 SuiteCloud 项目的文件夹。
suitecommerce:localserver生成您的 SuiteCommerce 扩展和主题的本地服务器。

特定命令的帮助,请运行以下命令:suitecloud {command} -h 想要查看全部命令的详细文档,请前往NetSuite 帮助中心

四、创建工程

1、创建项目

(1)输入suitecloud project:create -i 命令创建项目,此时会有两种项目类型选择

  • Account Customiztion Project(本次以此为例)
  • SuiteApp

Image.png (2)输入项目名。本次项目名:sdfDemo Image.png (3)确认是否在 Jest 测试框架中包含单元测试。本次选择:No Image.png (4)成功创建项目提示:The sdfDemo project was created successfully. Image.png

2、进入项目文件路径,选择或创建项目环境认证

(1)输入cd 项目路径 命令进入项目,例如:cd ~/sdfDemo (2)输入suitecloud account:setup 命令进行环境认证,选择或创建项目一个环境 Image.png (3)环境认证成功提示:The account has been successfully set up Image.png

3、导入对象

(1)输入suitecloud object:import -i 命令导入对像 (2)确认是否导入全部对象。选择No则需要手动选择所需对象 Image.png (3)确认是否通过脚本ID过滤找到想要的对象 (4)确认选择要导入的对象 (5)确认是否要导入对象中引用的 SuiteScript 文件 (6)选择要导入对象的文件夹 (7)确认是否选择要导入对象的文件夹项目中所有选定的对象及其引用的 SuiteScript 文件都将被帐户中的对象和文件覆盖 Image.png

五、导入依赖

输入suitecloud project:adddependencies 命令导入依赖 Image.png

六、选择或创建目标环境

输入suitecloud account:setup 命令进行目标环境认证 Image.png

七、部署到目标环境

输入suitecloud project:deploy 命令部署到目标 Image.png

八、参考资料

SuiteCloud CLI for Node.js

CLI for Node.js Reference