amore-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Amore CLI

Amore CLI

Amore is a macOS app distribution platform. The
amore
CLI automates the entire workflow for publishing macOS apps outside the App Store: setup, code signing, notarization, DMG creation, Sparkle appcast generation, and upload — in a single command.
Run
amore help
or
amore <command> --help
for the most up-to-date option details.
Amore是一个macOS应用分发平台。
amore
CLI可自动化完成在App Store外发布macOS应用的全流程工作:设置、代码签名、公证、DMG创建、Sparkle appcast生成和上传——仅需一条命令。
运行
amore help
amore <command> --help
查看最新的选项详情。

Installation

安装

The CLI ships inside the Amore macOS app. To use it:
  1. Download Amore from amore.computer/download
  2. Install the CLI via terminal:
    sh
    /Applications/Amore.app/Contents/MacOS/AmoreCLI install
    Or install from within the app: go to Command Line settings and click Install.
This creates a symlink at
/usr/local/bin/amore
. If you get a permission error, run with
sudo
.
Important: The CLI currently requires Amore.app to be installed on the machine. It is not available as a standalone binary, so it cannot run on CI runners (like GitHub Actions) that don't have Amore.app. All
amore
commands are meant to be run on your local Mac.
CLI附带在Amore macOS应用内。使用方式如下:
  1. amore.computer/download下载Amore
  2. 通过终端安装CLI:
    sh
    /Applications/Amore.app/Contents/MacOS/AmoreCLI install
    或在应用内安装:前往命令行设置页面,点击安装。
这会在
/usr/local/bin/amore
位置创建一个符号链接。如果遇到权限错误,加上
sudo
运行。
重要提示: 当前CLI要求设备上安装Amore.app才能使用。它不提供独立二进制文件,因此无法在未安装Amore.app的CI运行器(如GitHub Actions)上运行。所有
amore
命令都需要在你的本地Mac设备上运行。

Quick Start

快速开始

sh
amore login                     # Sign in
amore setup MyApp.app           # Register app, choose hosting, generate Sparkle keys
amore release --scheme MyApp    # Build, sign, notarize, and publish
sh
amore login                     # 登录账号
amore setup MyApp.app           # 注册应用、选择托管方式、生成Sparkle密钥
amore release --scheme MyApp    # 构建、签名、公证并发布

Commands Overview

命令概览

CommandDescription
login
Sign in to your Amore account
logout
Sign out
register
Create a new account
whoami
Show current user (use
--refresh
to sync)
install
Install CLI to
/usr/local/bin/amore
uninstall
Remove CLI from
/usr/local/bin/amore
status
Show CLI setup status
setup
Register a new app for distribution
release
Build, sign, notarize, and publish a release
apps
List or delete apps
releases
List, update, or delete releases
products
Manage licensing products (create, update, delete)
config
View or change per-app configuration
create-dmg
Create a DMG without uploading
sign
Sign an archive with Ed25519 key
verify
Verify an Ed25519 signature
post-archive
Xcode archive post-action for automated releases
命令描述
login
登录你的Amore账号
logout
登出账号
register
创建新账号
whoami
显示当前用户(使用
--refresh
同步信息)
install
将CLI安装到
/usr/local/bin/amore
uninstall
/usr/local/bin/amore
移除CLI
status
显示CLI设置状态
setup
注册待分发的新应用
release
构建、签名、公证并发布版本
apps
列出或删除应用
releases
列出、更新或删除发布版本
products
管理许可产品(创建、更新、删除)
config
查看或修改单应用配置
create-dmg
仅创建DMG文件不上传
sign
用Ed25519密钥签名归档文件
verify
验证Ed25519签名
post-archive
用于自动化发布的Xcode归档后置动作

Core Workflows

核心工作流

Setting Up a New App

新应用设置

amore setup <path-to-app>
walks through:
  1. Choosing hosting: Amore (managed) or S3 (self-hosted)
  2. Generating or importing EdDSA Sparkle signing keys
  3. Configuring S3 credentials (if self-hosted)
For non-interactive setup (CI/agents), pass all options as flags. Read
references/commands.md
for the full flag list.
amore setup <path-to-app>
会引导你完成以下步骤:
  1. 选择托管方式:Amore(托管版)或S3(自托管)
  2. 生成或导入EdDSA Sparkle签名密钥
  3. 配置S3凭证(如果选择自托管)
如需非交互式设置(CI/Agent),可将所有选项作为参数传入。完整参数列表可查看
references/commands.md

Releasing

发布版本

amore release
is the main workhorse. It accepts
.app
,
.dmg
,
.zip
,
.xcarchive
,
.xcodeproj
, or
.xcworkspace
as input and handles the full pipeline:
  1. Archive/export (if given an Xcode project)
  2. Code sign with Developer ID
  3. Create DMG with drag-to-install experience
  4. Notarize with Apple
  5. Sign for Sparkle (Ed25519)
  6. Upload and update appcast.xml
Read
references/release-workflow.md
for the full release pipeline details, CI/CD automation, and all flags.
amore release
是核心命令。它支持
.app
.dmg
.zip
.xcarchive
.xcodeproj
.xcworkspace
格式的输入,可处理完整的发布流程:
  1. 归档/导出(如果输入是Xcode项目)
  2. 使用Developer ID进行代码签名
  3. 创建支持拖拽安装体验的DMG文件
  4. 向Apple提交公证
  5. 为Sparkle签名(Ed25519)
  6. 上传并更新appcast.xml
完整的发布流程详情、CI/CD自动化配置和所有参数可查看
references/release-workflow.md

Managing Releases

版本管理

sh
amore releases list --bundle-id com.example.App
amore releases update <id> --bundle-id com.example.App --published true
amore releases delete <id> --bundle-id com.example.App
Releases support flags:
--beta
,
--critical
,
--phased-rollout
,
--published
,
--release-notes
.
sh
amore releases list --bundle-id com.example.App
amore releases update <id> --bundle-id com.example.App --published true
amore releases delete <id> --bundle-id com.example.App
版本支持以下参数:
--beta
--critical
--phased-rollout
--published
--release-notes

Configuration

配置管理

Per-app settings are managed with
amore config
:
sh
amore config show --bundle-id com.example.App           # Show all config
amore config show release --bundle-id com.example.App    # Show release config only
amore config set release codesign-identity "Developer ID Application: You" --bundle-id com.example.App
amore config set s3 bucket my-bucket --bundle-id com.example.App
Config sections:
release
,
s3
,
app
. Read
references/commands.md
for all fields.
单应用设置通过
amore config
管理:
sh
amore config show --bundle-id com.example.App           # 显示所有配置
amore config show release --bundle-id com.example.App    # 仅显示发布配置
amore config set release codesign-identity "Developer ID Application: You" --bundle-id com.example.App
amore config set s3 bucket my-bucket --bundle-id com.example.App
配置分为
release
s3
app
三个部分。所有字段说明可查看
references/commands.md

When to Consult Reference Files

何时查阅参考文档

Read these for deeper guidance on specific topics:
TopicReference FileWhen to Read
Full command reference
references/commands.md
Looking up specific flags, arguments, or subcommands
Release pipeline
references/release-workflow.md
Setting up CI/CD, troubleshooting releases, understanding the pipeline
S3 self-hosting
references/s3-hosting.md
Configuring S3/R2 buckets, credentials, appcast paths
Sparkle integration
references/sparkle-setup.md
Adding Sparkle to a project, key management, sandboxing
Licensing & payments
references/licensing.md
Setting up products, Stripe integration, payment flows
如需特定主题的深入指导,可查看对应的参考文档:
主题参考文件适用场景
完整命令参考
references/commands.md
查询特定参数、变量或子命令时
发布流程
references/release-workflow.md
设置CI/CD、排查发布问题、理解发布流程时
S3自托管
references/s3-hosting.md
配置S3/R2存储桶、凭证、appcast路径时
Sparkle集成
references/sparkle-setup.md
为项目添加Sparkle、密钥管理、沙箱配置时
许可与支付
references/licensing.md
设置产品、Stripe集成、支付流程时

Common Patterns

通用规则

Bundle ID is the primary identifier. Most commands that operate on an app require
--bundle-id
(or
-b
).
Interactive vs non-interactive. Commands like
setup
and
release
are interactive by default. Pass all required values as flags to skip prompts. Note:
login
and
register
are always interactive — there are no
--email
/
--password
flags.
Local Mac only. The CLI requires Amore.app to be installed and runs on macOS only. It is not available as a standalone binary for CI/CD runners. If a user asks about CI/CD automation, explain this limitation and suggest using the Xcode post-archive action or running
amore release
locally after building.
S3 credentials. Can be provided via: CLI flags (
--s3-access-key-id
,
--s3-secret-access-key
), environment variables (
AWS_ACCESS_KEY_ID
,
AWS_SECRET_ACCESS_KEY
), or the macOS keychain (configured during
amore setup
).
Codesigning prerequisites. DMG creation and notarization require a Developer ID Application certificate and a notarization keychain profile. Set these up once with
amore config set release
.
Back up your Sparkle private key. After
amore setup
generates your EdDSA signing key, store a copy in your password manager. If you lose it, existing users will not be able to verify future updates — there is no way to recover it.
Bundle ID是主要标识符。 大多数针对应用操作的命令都需要传入
--bundle-id
(或
-b
)参数。
交互式与非交互式模式。
setup
release
等命令默认是交互式的。传入所有必填参数可跳过提示。注意:
login
register
始终是交互式的,没有
--email
/
--password
参数。
仅支持本地Mac运行。 CLI要求安装Amore.app,且仅能在macOS上运行。不提供适用于CI/CD运行器的独立二进制文件。如果用户询问CI/CD自动化相关问题,请说明该限制,建议使用Xcode归档后置动作,或在构建完成后本地运行
amore release
S3凭证。 可通过以下方式提供:CLI参数(
--s3-access-key-id
--s3-secret-access-key
)、环境变量(
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
)或macOS钥匙串(在
amore setup
过程中配置)。
代码签名前置要求。 DMG创建和公证需要Developer ID Application证书和公证钥匙串配置。可通过
amore config set release
完成一次配置即可。
备份Sparkle私钥。
amore setup
生成EdDSA签名密钥后,请在密码管理器中存储一份备份。如果丢失密钥,现有用户将无法验证后续更新——且密钥无法恢复。