参考手册CLI 命令

账号

cdg auth login、logout 与 status 的作用和使用前提,以及让 CLI 改用另一个账号的做法。

内测即将开始,CodeDAG 暂未开放安装。可以先加入 Waitlist,邀请会分批通过邮件发出。
在 GitHub 上编辑

cdg auth 下有三个命令,分别用来登录 CodeDAG、退出登录和查看当前账号。它们可以在任何目录中运行,不需要位于项目内;登录状态按电脑保存,同一台电脑上的所有项目共用一个登录。除 --help 外,只有 cdg auth status 另有一个选项 --local。为什么需要登录、哪些命令需要登录、登录状态能保持多久,见登录与账号。

cdg auth login

Terminal
cdg auth login

这个命令在浏览器中用 Google 账号登录 CodeDAG,并把登录状态保存在这台电脑上。第一次用某个 Google 账号登录时,会同时为它创建 CodeDAG 账号,不需要事先注册。

命令要求能连上 CodeDAG 服务,连不上时会立即失败,不会打开浏览器。登录必须在运行命令的这台电脑上用浏览器完成,所以在 SSH 远程会话、容器或没有图形界面的服务器里无法登录,见没有桌面浏览器时。打开浏览器后,命令最多等待 5 分钟,超过时间还没有完成登录,命令就以失败结束,重新运行即可。

已经登录时再次运行,会重新走一遍登录,成功后用新的登录替换这台电脑上原有的登录;这次登录没有完成时,原有的登录保持不变。

平时不必专门运行这个命令:cdg init、cdg dag submit 与 cdg auth status 发现还没有登录时,会先带你完成同样的登录,再继续执行原来的命令。需要单独运行它的,主要是换账号的时候,以及排队中的工作流因为这台电脑没有登录而停在 on-hold 的时候。

cdg auth logout

Terminal
cdg auth logout

这个命令退出这台电脑上的 CLI 登录,并清除本机保存的登录状态。网页控制台和其他电脑上的登录不受影响;退出对排队中的工作流有什么影响,见退出与切换账号。

退出不需要联网。连不上 CodeDAG 服务时,命令会给出一条警告,但本机的登录状态仍会被清除。

cdg auth status

Terminal
cdg auth status [--local]

不带选项时,这个命令显示当前登录的账号、订阅状态和本周期的额度用量,各项的含义见查看额度与用量。

这种用法需要登录,并且要能连上 CodeDAG 服务。还没有登录时,它会先带你完成与 cdg auth login 相同的登录,再显示账号信息。

--local

cdg auth status --local 只按这台电脑上保存的登录凭证回答是否已经登录,不联网,也不会带你进入浏览器登录,适合脚本和 Agent 在运行需要登录的命令之前使用:已登录时退出码为 0,未登录时为 1。它只显示用户 ID,不显示邮箱、订阅和额度;登录已经在服务端失效时,它仍然显示已登录。

退出与切换账号

要让这台电脑上的 CLI 改用另一个账号,先退出,再登录另一个 Google 账号,最后确认当前的账号:

Terminal
cdg auth logout
cdg auth login
cdg auth status

如果浏览器里的网页控制台(app.codedag.com)还登录着原来的账号,cdg auth login 会直接沿用它,这时先在网页上退出,再运行登录命令。多台电脑怎样共用一个账号,以及登出的完整规则,见登出、多台电脑与切换账号。

退出和切换账号不影响已经开始执行的工作流。排队中的工作流轮到执行时,这台电脑上的 CLI 必须登录着提交它的账号,否则它会停在 on-hold,排在后面的工作流也跟着等待;登录或切回原账号后执行 cdg dag recover <工作流> 即可继续。

相关

  • 登录与账号:哪些命令需要登录、登录状态能保持多久,以及 CodeDAG 服务会收到哪些数据。
  • 额度、订阅与扣费:免费额度、订阅,以及额度在什么时候扣除。
  • 故障排除:登录失败、反复要求登录,或登录后账号不对时,按现象排查。

最后更新