语气
apex 开发者和操作者 CLI(TypeScript,指揮官).
工作空间 顶级动作 仓库。 里面的东西: docs/architecture/components/cli.md公约: docs/conventions/。 。 。 .
图标
| 命令 | 范围 | 需求 |
|---|---|---|
apex run | 运行二进制, 本地 | apex-runner 打开 PATH |
apex validate | 本地引擎二进制 | apex-engine 打开 PATH |
apex migrate scan | 引擎二进制 + GitHub REST API | apex-engine 打开 PATH· ; GITHUB_TOKEN 除非 --path |
apex logs | 控制飞机 REST API | 客户代号: actions:read (单位:千美元)logs delete数字 : actions:write),或机器符号 |
apex dispatch | 控制飞机 REST API | 客户代号: actions:write,或机器符号 |
apex login • 妇女 logout • 妇女 whoami | 浏览器和控制平面 REST API | 没什么.. login 薄荷证书 |
apex token create | 浏览器和控制平面 REST API | 登记到仪表盘的人,谁批准它 |
apex token edit | 控制平面 REST API; 扩展的浏览器 | 客户代币缩小; 个人在仪表板上签字扩大 |
apex token list • 妇女 revoke | 控制飞机 REST API | 客户代币(APEX_TOKEN 或者说 apex login(中文(简体) ) |
apex secret • 妇女 apex variable | 控制飞机 REST API | 客户代号: secrets:* 编号 : variables:* (单位:千美元)APEX_TOKEN 或者说 apex login(中文(简体) ) |
apex login --console • 妇女 logout --console | 浏览器中的管理控制台,以及控制平面 REST API | 接线员签到行政控制台,由行政控制台批准 |
apex grant list • 妇女 apex tenant installations | 控制飞机管理员API | 运算符( e)apex login --console),或机器符号 |
apex grant create • 妇女 update • 妇女 revoke | 控制飞机管理员API | 运算符( e)apex login --console——从不给机器代币(api ADR-0056 (英语), api ADR-0079 (英语) |
其它客户命令 cli/reference.ts 名称它需要的许可; 公众参考显示它.
生成的引用 : docs/features/cli-commands.md (单位:千美元)pnpm docs:cli 从 packages/tooling),以及
公共网站所建的结构, apps/cli/cli-reference.json (单位:千美元)pnpm docs:reference· ;
只有客户命令, 分类于 cli/reference.ts) (中文(简体) ).
export APEX_API_URL=https://apex.example
export APEX_ADMIN_TOKEN=… # the machine token, not a person's session
apex dispatch .github/workflows/deploy.yml --repo octo/app --ref main --input environment=production
apex logs latest --repo octo/app --follow # exits non-zero if the run failed
apex logs '#42' --job test # one job, clean enough to pipe
apex migrate scan 回答"会运行我的工作流程" 在任何东西移动之前。 每个判决都来了
从发动机与证明它的固定装置的相符合性(cli ADR-0002, (英语), engine ADR-0013) - (英语)
这里没有关于兼容性的第二个意见。 它进口秘密和可变 名称 财务报告和审定财务报表
永远没有价值,和 --path 扫描此机器上的一次检出, 没有符号和网络 :
apex migrate scan --path . # this repository, no credentials
apex migrate scan acme --repo acme/api --json # one repository of an organization
全权证书
CLI决定一个证书, 依此顺序(api ADR-0064,经
ADR-0005 (英语)(b) —— 环境排行榜
文件数字 :
APEX_TOKEN- 在仪表板上铸造一个标志(/settings/tokens),用于CI和脚本;APEX_ADMIN_TOKEN——接线员的机器代号,不变:没有被扫描,所以将其视为根 证书。 输出变量是故意选择,因为GH_TOKEN排行gh存储 登录; 一个保存的登录用来取胜, 所以操作员 shell 充当上次运行的客户apex login在机器上;- 符号
apex login保存在$XDG_CONFIG_HOME/apex/credentials(默认)~/.config, (中文(简体) ), 模式0600在一个0700目录——按组或其他内容可读的文件 拒绝,作为ssh拒绝私钥; - 否则命令随出口2而停止,命名
APEX_TOKEN财务报告和审定财务报表apex login。 。 。 .
运算符命令 —— 说 apex grant 财务报告和审定财务报表 apex tenant installations - 先找找 - 找找看 - look first for the 运算符
符号 apex login --console 保存在 $XDG_CONFIG_HOME/apex/console-credentials (相同的模式规则),何时
未过期,由控制平面制造 APEX_API_URL 名称,或者使用以上顺序
(单位:千美元)api ADR-0079 (英语). 运营符在行政控制台上获得批准(APEX_CONSOLE_URL,或
API的软件 app. 主机读取为 admin.由操作员进行,仅通过回回;最多一周,并达到
只有捐赠路线和安装清单,并且每笔捐赠都写上其经营者的名字。 那个机器
符号可以列出赠款并被拒绝每次写作. apex logout --console 撤销并忘记它.
APEX_API_URL 选择控制平面( 默认) https://app.apexactions.com; 保存的登录是
只是被送到了发布它的控制飞机上. apex login 在网络上打开同意页面
应用 - APEX_WEB_URL,或者 API 的起源——并听 127.0.0.1 循环回调
(RFC 8252, PKCE); 代码被赎回后, 它把标签交给网络应用的裸体 /cli/done
页 次api ADR-0075 (英语). 在该机器上无法打开浏览器的地方—— SSH会话
(单位:千美元)SSH_CONNECTION编号 :SSH_TTY),编码空间,dev容器, /.dockerenv,或 Linux 没有 DISPLAY
也没有 WAYLAND_DISPLAY ——或与 --device (或 --no-browser,它使用 设备流动 相反(RFC 8628,
由 Apex 运行 : 它打印一个代码和 …/cli/device在任何设备上输入密码 包括电话,
和CLI民意测验——荣誉 interval 财务报告和审定财务报表 slow_down ——直到批准,拒绝或代码的十
几分钟结束. --browser 坚持回转. apex token create 以及扩大 apex token edit 带
同为三旗. 客户代币 权限 (单位:千美元)resource:read|write,写作暗示
已读; 资源 actions, (中文(简体) ), approvals, (中文(简体) ), deployments, (中文(简体) ), secrets, (中文(简体) ), variables, (中文(简体) ), environments, (中文(简体) ), notifications, (中文(简体) ),
administration)属于 一个账户 (单位:千美元)api ADR-0071 (英语). 它到达存储器的路线
赠款包括个人作用范围内的赠款和账户所有者的象征性政策; apex login 拿着保险单
在账户中默认某人的角色(所有者:一切) --account 名称,如果有超过
一个 一条路,它缺乏 资助答案403 this token needs <permission>,而CLI则与
apex token edit <id> --add-permission <permission> 这会增加它. apex whoami
名称、使用证书、发现地点和任何其他证书
排名超过. apex logout 取消服务器上保存的令牌,
然后删除文件。 没有命令打印一个符号——除了 apex token create他们的全部工作是:
印出一个新的,一次.
apex login # once per machine
apex login --device # over SSH: approve from a phone with the printed code
printf %s "$TOKEN" | apex secret set ETS_PACKAGES_TOKEN --repo acme/api --repo acme/web
apex secret set DEPLOY_KEY --repo acme/api --from-file ./deploy.key
apex variable set AWS_REGION --value eu-west-1 --repo acme/api
apex secret list --repo acme/api --json # names only
管道会得到它自己的象征。 它像登录一样在浏览器中被批准, 印出一次Stdout,
并且从未保存( n)api ADR-0064:一个从未铸造过标志:
apex token create ci-deploy --permission actions:write --permission secrets:write \
--repo acme/api --expires-in-days 30 # token on stdout, details on stderr
apex token edit <id> --remove-permission secrets:write # narrowing: applies at once
apex token edit <id> --add-permission deployments:write # widening: approved in the browser
apex token list # by Account, with grants; * marks the one in use
apex token revoke 0b6f1c2e-9d4a-4f7e-8a31-5c2d9e7b1a40 # or --all
apex secret set 永远不会从命令行中取出值 —— argv 可见于 ps 保存在
外壳历史(BUG-0157)——如此 --value 以2号出口拒绝。 退出代码: 0 完成 : 1 API
拒绝 ^ 2 个用法或配置 ^ 3 未在 delete。 。 。 .
版式
cli/<command>/main.ts- 每个命令一个指挥官叶子(§7)src/domain/——纯决定:运行和职务选择,输入解析,退出代码src/application/- 港口上使用个案src/infrastructure/——适配器:引擎和跑道二进制,REST API- 文档是根源:
docs/adrs/cli/,其余按类别分列docs/(TASK-0526) (韩语) VERSION——发布版本,其中version:sync从根( ADR- 0048) 写出; 从未手工编辑
许可证
@apex-actions/cli 专有软件,根据
Apex 动作软件许可证 看到了吗 LICENSE。 。 。 .
它所谈的主办服务由 服务条件。 。 。 .