应用 CLI

管理命令行的应用程序和块 .

目录

• 安装
• 使用量
  • 认证
  • 组织
  • 应用程序
  • 块
  • 组
  • 资产
  • 资源
  • 备份恢复
  • 连续工作
• 许可证

安装

npm install @appsemble/cli

使用量

通过运行以下命令可以实现完整的功能列表:

appsemble --help

每个子命令也支持 --help 旗帜.

认证

Appsemble CLI使用OAuth2客户端认证到Appsemble服务器.

要登录, 运行以下命令并遵循输出中的指令 :

appsemble login

要登录, 请运行以下命令并选择要删除的客户端证书 :

apsemble logout

应用 CLI 还支持使用 APPSEMBLE_CLIENT_CREDENTIALS 环境 变量。 这对自动化大多有用.

组织

应用CLI可以用来创建和更新组织. 例如:

appsemble organization create my-organization --name 'My Organization' --icon icon.png

应用程序

Appsemble CLI 允许您将 Appsemble 应用程序拖入标准 Appsemble 项目布局. 命令后再接一系列交互式问题. 您也可以通过数值作为 参数.

appsemble app create

Appsemble CLI可用于创建,导出,导入并更新应用. 例如,创建 应用程序在 apps/my-app 目录, 运行 :

appsemble app publish apps/my-app

同样,为了使用应用程序目录更新应用程序,运行以下命令:

appsemble app update --id <app-id> <path/to/updated app>.

如果您想要更新应用程序的设置, 请运行以下命令 :

appsemble app patch --id <app-id>

使用 --help 带有上述命令的旗帜以查看支持的参数.

\ N注

这个 app patch 命令支持更新 locked 应用程序的属性,锁定的属性是 在其它属性之前更新。 如果您设置锁定属性为 fullLock,任何其他更改 除非您正在使用,否则将不会应用 --force 旗帜.

要使用 CLI 删除应用程序,使用以下命令:

appsemble app delete --id <appId>

要导出一个app作为zip文件, 请运行如下 :

appsemble app export --id <app-id>

此命令的支持参数是 resources, (中文(简体) ), assets 财务报告和审定财务报表 path资源用于 指定是否在导出文件中包含资源,同样也适用于资产和 路径是要将已下载文件放入文件夹的路径。 默认路径是 ./apps,资源和资产违约 false。 。 。 .

要从zip文件中导入应用程序,请使用以下命令:

appsemble app import <path-of-zip-file> --organization <organizationId>

为了更深入地解释如何建造应用软件,请使用我们 应用程序构建指南。 。 。 .

块

Appsemble CLI 允许您将 Appsemble 块拖入标准 Appsemble 项目 设置。 命令后再接一系列交互式问题.

appsemble block create

虽然我们不建议在 生产)相貌块. 例如,在 blocks 目录, 运行 :

appsemble block publish blocks/*

或发布位于其他目录中的单个块,运行

appsemble block publish path/to/block/directory

块如果没有被任何应用程序使用,可以被删除. 要删除块, 请运行

appsemble block delete <block-name:block-version>

组织 id 可以作为论据(默认为“应用”).

要进一步了解与块相关的命令, 请运行

appsemble block --help

构件用途 网络软件包。用于 在此安装额外的依赖 webpack 财务报告和审定财务报表 @appsemble/webpack-config

npm install webpack@webpack-4 @appsemble/webpack-config

为了更深入地解释如何建造应用软件,请使用我们 块开发指南。 。 。 .

组

Appsemble CLI可以用来管理应用程序的组. 例如,以下命令创建 新组名 My Group数字 :

appsemble group create 'My Group' --app-id 1 --context development

资产

Appsemble CLI可用于从磁盘上上传资产. 例如,以下命令创建 名为 example-asset数字 :

appsemble asset publish --app-id 1 path/to/example-asset.png

资源

应用 CLI 可用于从 JSON 文件或目录创建资源 :

[
  {
    "title": "My Resource",
    "description": "This record is an example."
  }
]

appsemble resource publish --app-id 1 --context development --app path/to/my-app my-resource path/to/resources/my-resource.json

appsemble resource publish --app-id 1 --context development --app path/to/my-app my-resource path/to/resources/*

而资源也可以在JSON文件中包含一个ID后被更新.

[
  {
    "id": 1,
    "title": "My Updated Resource",
    "description": "This will be the updated content of the first my-resource record."
  }
]

appsemble resource update --app-id 1 --context development --app path/to/my-app my-resource path/to/resources/*

备份恢复

Appsemble CLI 可用于从创建的备份文件中恢复应用程序和数据库数据 backup-production-data (例如, npm run appsemble -- backup-production-data) (中文(简体) ). 备份文件 使用该格式 <backupsFilename>_<YYYYMMDDHHmmssSSS>.sql.gz (例如, appsemble_prod_backup_20250101093045123.sql.gz) (中文(简体) ). 使用最新的备份文件名( 例如 检查一下 rclone)和您的对象存储证书:

npm run appsemble -- restore-data-from-backup --restoreBackupFilename <backupsFilename_YYYYMMDDHHmmssSSS.sql.gz> --backupsHost <your-object-storage-host> --backupsAccessKey <your-backups-access-key> --backupsSecretKey <your-backups-secret-key>

恢复备份后, 运行重加密命令 :

npm run appsemble -- reencrypt-secrets --old-aes-secret <old-aes-secret>

连续工作

Appsemble CLI可以用于运行app cronjobs. 以下命令将运行所有已设置的 计划5分钟内运行:

appsemble run-cronjobs

工作运行的频率(更准确地说,工作运行的时间可以追溯多久) 时间间隔(以分钟计)也可以用:

appsemble run-cronjobs --interval 30

许可证

LGPL-3.0 仅限 © 应用