@ datadog/ apps- cli

交互式CLI用于认证,构建,以及部署 Datadog Apps.

使用量

npx @datadog/apps-cli

在没有参数的情况下,在交互式终端中,此选项打开一个菜单 可用命令。 在非互动背景下( CI, 脚本, AI 代理) 它 而不是打印纯命令列表和退出.

命令也可以直接运行,绕过菜单:

npx @datadog/apps-cli auth login
npx @datadog/apps-cli upload --site datadoghq.com

运行 npx @datadog/apps-cli --help,或 npx @datadog/apps-cli <command> --help, (中文(简体) ), 供充分利用和选择.

在一个有CLI作为dev依赖的项目(设置 @datadog/create-apps 创建, npx @datadog/apps-cli <command> 使用该 (原始内容存档于2018-09-29). project's own copy. 经过全局安装( A)npm install -g @datadog/apps-cli,二进制在您的 PATH 作为 datadog-apps; 数据 CLI本身的输出以该形式显示命令.

图标

• auth login ——通过 OAuth 登录到 Datadog
• auth status ——显示 Datadog 认证状态
• auth logout ——登录出 Datadog,撤销并清除所储存的 OAuth 令牌
• auth default —— 设置用于 Datadog 站点的默认值
• build ——在本地构建您的 Datadog App
• upload ——构建,上传,并发布您的 Datadog App 捆绑活性
• dev 启动项目 Datadog 证书解决后 dev 服务器

认证

auth login 打开浏览器以授权此 CLI 对抗 Datadog org 通过 欧奥特. 它支持立刻登录到多个类——运行到 登录到同一(或不同)站点上的第二个窗口。 每个兽人 由UUID识别.

用于认证的 Datadog 站点按此顺序解决:

1. 明确 --site 旗帜(例如:. --site datadoghq.eu,或完整的 URL/客户端 子域类 myorg.datadoghq.com(中文(简体) )
2. 这个 DD_SITE 或者说 DATADOG_SITE 环境变量( e)DATADOG_- 前缀 如果两者被设定为不同的值,则胜出)
3. 这个 datadogSite 字段中 datadog-app.config.json (应用程序配置)
4. 在互动会议上,从网站快速.

这意味着在Datadog App项目目录中有一个 datadog-app.config.json, (中文(简体) ), datadog-apps auth login 工作时没有旗帜 都说吧 如果您的项目早于 datadog-app.config.json,询问您的编码代理 ,以便根据其中的指示升级 docs/agents/upgrading.md。 。 。 .

需要 OAuth 登录的命令启动浏览器的登录流 当其站点没有保存登录,或保存的站点已过期且无法登录时 已刷新——但仅在交互式终端. 非互动背景(CI, 脚本, AI 代理) 以出错退出; 使用 API 和应用程序密钥 在这里.

API 和应用程序密钥

部署指挥部upload和 dev 还接受 DD_API_KEY 财务报告和审定财务报表 DD_APP_KEY -或者说 DATADOG_API_KEY 财务报告和审定财务报表 DATADOG_APP_KEY。 。 。 . 当两个密钥被设定时, CLI 都会随每个请求一起发送并跳过 OAuth 完全 : 没有存储的登录会选择请求的 org —— 由密钥决定哪个 org 每个请求都到达。 这使得命令在 CI 和其他 非交互式上下文,其中浏览器无法登录.

当两个密钥中只有一个被设定时,两者都会被忽略. 然后使用CLI 如上文所述,OAuth.

两种方法都以同样方式解决网站: --site,则 DATADOG_SITE,则 DD_SITE,然后是 datadogSite 操作中的字段 目录的 datadog-app.config.json 或,何时 --org 登录名称 org,为org储存的网站.

使用 API 和应用程序密钥,没有存储会话 。 因此,对于一个矿石 使用自定义子域的 US1 外部 datadoghq.com,给出 数据中心网站(例如) --site us3.datadoghq.com),而不是习惯 子域主机 .

Dev 服务器

dev 启动工程的 dev 服务器( e)npx vite,与 --mode 当给与, 或者说 --mode dev-verify 页:1 --verify全权证书已解决: DD_API_KEY编号 :DD_APP_KEY 双双设定, 或选中的 OAuth 组合 访问符号为 DD_OAUTH_ACCESS_TOKEN 否则。 Dev 服务器读取 以您的名义调用 Datadog API 的符号 。 您不需要配置 证书在 dev 服务器本身 .

Dev会话持续数小时,所以 dev 更新 OAuth 访问符前 当它还剩不到22小时有效时开始,并储存新的 一个 因此,该标志从至少22小时有效开始——足够 一个工作日,虽然一个dev服务器 关闭了几天 可能会超过它 需要重新启动 .

看看你是谁,跑 auth status - 它印出所有的东西 为每个网站/org存储,包括每个Og的UUID。 要签了,跑 auth logout ——单登录存储后,立即日志出;更多 不止一个,它促使你选择哪一个。 跳过提示,通过 --org <uuid> 要登录 准确的org, --site 以登录到每个数值 在一个地点,或 --all 清除每个存储的登录.

正在注销 在 Datadog 取消 OAuth 会话不只是当地,所以 即使复制品漏出,标志也停止工作. 如果无法联系到数据犬 ——你下线了,或者请求时间出 -- auth logout 仍然清除 证书使用此机,但警告会议可能仍在活动。 改为: 取消会话后,您可直接取消 CLI 的授权 在个人设置 > Apps 下的数据犬.

如果在一个站点上登录了一个以上的鼠标,则需要单个命令 符号选择该站点的默认设置( i)auth default),或 只有一只被登录的独角兽 运行 auth default -或者说 auth default --site <site> ——选取哪一个圆形;如果登录了不止一个 那个网站,它促使你选择。 为了在不急的情况下设置,通过 灰熊的UUID : auth default --org <uuid>。 。 。 .

保存证书的地方

登录以 credentials.json 在本目录下,以其中先解决的为准:

$DD_APPS_CONFIG_DIR or $DATADOG_APPS_CONFIG_DIR   # if set
$XDG_CONFIG_HOME/datadog-apps                     # if set to an absolute path;
                                                   # a relative value is ignored
~/.config/datadog-apps

处理 credentials.json 作为秘密 任何能读到的东西 这些符号——和使用 auth logout 要清除它们而不是删除文件 手边.

构建

build 财务报告和审定财务报表 upload 运行 vite build 与已解决的站点同时存在 DD_SITE 财务报告和审定财务报表 DATADOG_SITE,替换任何继承的价值,所以 upload --site 正在建设 对它上传到的网站. build 从 DATADOG_SITE, (中文(简体) ), 接下来 DD_SITE,则 datadog-app.config.json类似 upload它停止在一个 无效的站点, 或者在错误的站点上 datadog-app.config.json 当它读到 文档。 与 upload,它与继承的环境一起在没有来源的情况下构建 命名一个网站.

许可证

阿帕奇 - 2.0