Steedos Cli 命令

source命令

使用source命令可以实现源数据和非源数据的双向同步, 同时本地将生成源格式的元数据文件。

您也可以运行--help来获取source命令的更多信息

steedos source --help

USAGE

$ steedos source:COMMAND

COMMANDS

source:config

source:convert

source:delete

source:deploy

source:retrieve

source:retrieve

从服务器获取源格式的元数据并下载到本地 Steedos DX项目中，该命令会直接覆盖掉您本地的文件。

该命令包含的可选参数：

1、[-m | metadata]

可选metadata:

"CustomAction","CustomApplication",

"CustomField","CustomListview",

"CustomObject","CustomPermission",

"CustomPermissionset","CustomProfile",

"CustomValidationRule","Layout","Workflow"

参数说明

• CustomApplication

自定义应用程序，包括自定义或标准应用程序

• CustomField

自定义对象字段，包括自定义或标准对象字段

• CustomListview

自定义对象列表，包括自定义或标准对象列表，如all，recent等

• CustomAction

自定义对象按钮，包括自定义的对象操作按钮

• CustomObject

自定义对象，用户自定义对象名称会自动加__c后缀，以此和系统对象进行区别

• CustomPermission

自定义对象权限，包括用户自定义或标准对象权限，如user，admin

• CustomPermissionset

自定义权限集，包括用户自定义权限集

• CustomProfile

自定义简档，包括用户自定义或系统标准简档，如user，customer等

• CustomReport

自定义报表

• CustomValidationRule

自定义对象验证规则

• Layout

• Workflow

工作流规则

2、[-p | source path]

根据地址来检索获取服务器数据

3、[-y | manifest]

您也可以运行--help来获取 source:retrieve 命令的更多信息：

steedos source:retrieve --help

根据本地配置文件（package.yml）从服务器获取所需源格式的文件

使用示例

根据metadata

获取对象 CustomObject

• CustomObject：*，表示获取所有对象及其包含的字段，列表，视图等

steedos source:retrieve -m CustomObject:*

• CustomObject:accounts，表示获取accounts对象及其包含的字段，列表，视图等

steedos source:retrieve -m CustomObject:accounts

获取某一对象的字段 Field

• CustomField:accounts.*，表示获取accounts对象的所有字段

steedos source:retrieve -m CustomField:accounts.*

• CustomField:accounts.boolean，表示获取accounts对象的某一字段

steedos source:retrieve -m CustomField:accounts.boolean

• CustomField:accounts.boolean,accounts.owner，表示获取accounts对象的多个字段

steedos source:retrieve -m

CustomField:accounts.boolean,accounts.owner

根据路径获取

• 获取该路径下所有

steedos source:retrieve -p path/to/source

• 获取某一确定文件

steedos source:retrieve -p "path/to/custom/objects/myObject.object.yml"

• 获取某一确定对象文件及其包含子文件

steedos source:retrieve -p "path/to/source/objects/myObject"

source:deploy

部署元数据到服务器

将本地文件部署到服务器

该命令包含的可选参数：

[-p | local file path] 您需要部署到服务器的本地文件路径

您也可以运行--help来获取 source:deploy 命令的更多信息：

steedos source:deploy --help

使用示例

• 部署steedos项目下所有文件到服务器

steedos source:deploy -p steedos-app\main\default

• 部署所有对象文件夹下的所有文件到服务器

steedos source:deploy -p steedos-app\main\default\objects

• 部署某一文件到服务器

steedos source:deploy -p steedos-app\main\default\object\note__c\fields\name.field.yml

• 或直接单文件名

steedos source:deploy -p name.field.yml

source:convert

【详见-项目转化】

将旧文件格式转化并本地生成metadata要求的新格式yml文件

该命令包含两个参数：

• 【-o | convertpath】需要转化的旧文件路径
• 【-t | targetPath】新格式文件生成的路径，须为绝对路径

您也可以运行--help来获取 source:convert 命令的更多信息：

steedos source:convert --help

示例如下：

steedos source:convert -o C:\GitHub\steedos-app-contract\src -t C:\GitHub\steedos-app-contract

source:config

【详见-安装 VS Code 插件-设置环境变量】

配置环境变量，同时会生成.env.local文件

steedos source:config

metadata server:(http://localhost:5000/)

metadata api key:OwOFMQOcRilzJpu0Q8ix0XOZjiJAT_B_CklKc6XULVe

其中：

- METADATA_SERVER 默认是http://localhost:5000/

- METADATA_APIKEY 可通过本地服务中的个人账户设置中获取到 APIKEY

package命令

【详见-使用 steedos cli 命令打包】

package:build

将本地文件打包成.package文件

该命令包含以下参数：

• 【-n | packageName】可选参数，打包好的package名称
• 【-p | appPath】需要打包的本地文件地址，绝对路径与相对路径均可
• 【-l | loglevel(debug|info|warn)】可选参数，用于控制是否打印已打包文件清单，默认"warn"不打印，只打印未打包文件清单

您也可以运行--help来获取 package:build 命令的更多信息：

steedos package:build --help

USAGE

$ steedos package:build

OPTIONS

-l, --loglevel=loglevel (debug|info|warn) [default: warn] logging level for this command invocation

-n, --packageName=packageName package name

-p, --appPath=appPath appPath

示例如下：

steedos package:build -n steedos-app-contract -p C:\GitHub\steedos-app-contract\steedos-app

在控制台同时会打印打包相关的日志：

=== Steedos Package Build: Packaged files

TYPE PROJECT PATH

────────────────── ──────────────────────────

CustomApplication steedos-app\main\default\applications

\projects.app.yml

=== Steedos Package Build: Unpacked files

TYPE PROJECT PATH

────────────────── ─────────────────────────────

i18n命令

【详见-生成国际化文件】

steedos:i18n

生成项目下对象的国际化文件

该命令包含以下参数：

• 【lng】 需要生成国际化的语言, 必填 (en | zh-CN)
• 【-p | packageDir】打包好的package名称
• 【-s | serverDir】项目所在路径, 默认为当前目录, 选填

您也可以运行--help来获取 steedos:i18n 命令的更多信息：

steedos i18n --help

Create steedos project object i18n

USAGE

$ steedos i18n NAME

ARGUMENTS

NAME language

OPTIONS

-p, --packageDir=packageDir Steedos Package Dir

-s, --serverDir=serverDir Steedos Server Dir

示例如下

steedos i18n en -s . -p ./steedos-app

data命令

data:export

导出数据库内的记录

该命令包含以下参数：

• 【-d | outputdir】导出文件生成的目录
• 【-f | fields】需要导出的对象字段名，多个字段名之间用逗号分隔
• 【-i | ids】需要导出的对象id，多个id之间用逗号分隔
• 【-o | objectName】需要导出的对象名称
• 【-p | plan】导出时生成一个plan文件及若干子文件
• 【-x | prefix】生成文件的前缀

您也可以运行--help来获取 data:export 命令的更多信息：

steedos data:export --help

USAGE

$ steedos data:export

OPTIONS

-d, --outputdir=outputdir Directory to store

generated files.

-f, --fields=fields fields

-i, --ids=ids ids

-o, --objectName=objectName objectName

-p, --plan Generates multiple sObject

tree files and a plan

definition file for

aggregated import.

-x, --prefix=prefix Prefix of generated files.

示例如下：

steedos data:export -o contracts -p

data:import

导入数据库内的记录

该命令包含的可选参数：

• 【-f | sobjectfiles】需要导入的文件名或路径，需要使用sobjectfiles或者plan.
• 【-p | plan】需要导入的plan文件名或路径，需要使用sobjectfiles或者plan.

您也可以运行--help来获取 data:import 命令的更多信息：

steedos data:export --help

USAGE

$ steedos data:export

OPTIONS

-d, --outputdir=outputdir Directory to store

generated files.

-f, --fields=fields fields

-i, --ids=ids ids

-o, --objectName=objectName objectName

-p, --plan Generates multiple sObject

tree files and a plan

definition file for

aggregated import.

-x, --prefix=prefix Prefix of generated files.

示例如下：

steedos data:import -f contracts.json

or

steedos data:import -p contracts-plan.json