DX CLI（命令名 dx）用于从命令行管理组织在 DX（getdx.com）平台上的软件目录、记分卡和工程数据。所有命令都通过 DX Web API 通信，并且需要身份验证。
一、用途 该工具面向需要以命令行方式操作 DX 平台数据的用户，覆盖软件目录（Software Catalog）、记分卡（Scorecards）以及工程数据的获取与管理，并支持对快照（Snapshot）分数、驱动因素评论和 CSAT 评论进行分析。
二、主要能力
- 软件目录管理：对实体（Entity）和实体类型（Entity Type）进行列出、查看、创建、更新和删除。实体是软件目录中代表服务、团队、库或其他被组织跟踪对象的记录，具有唯一标识符（slug）、类型、可选名称、描述、owner_teams、owner_users 以及类型化属性映射。实体类型定义某类实体所携带的属性和别名。属性支持 text、number、boolean、select、multi_select、url、date、user、list、json 等类型；使用 --property 时采用 key=value 语法，multi_select 和 list 类型的值以逗号分隔。别名用于将外部系统引用（如 GitHub 仓库 slug）映射到实体。
- 记分卡管理：通过 YAML 对记分卡和检查项（Check）进行列出、查看、创建、更新和删除。记分卡是评估实体健康度的框架，分为 LEVEL 型（按 Bronze/Silver/Gold 等命名等级排名）和 POINTS 型（实体从检查项累积分数）。检查项是记分卡内基于 SQL 的规则，其查询为每个实体返回 PASS、WARN 或 FAIL 状态。Initiative 是将失败的记分卡检查项按时间盒分组为团队可执行任务的项目。豁免（Exemption）是针对特定实体某项失败检查的限时批准通过，检查结果中 exemption_expires_at 非空即表示已豁免。
- 报告创建：Data Studio 报告（Report）是保存的磁贴（Tile）集合，组织在专门页面用于仪表盘和分享。每个磁贴包含保存的查询和图表配置，其 SQL 可引用报告变量。变量是以 $ 为前缀的命名占位符（如 $team_ids），内置变量包括 $service_ids、$team_ids、$tag_ids、$user_ids、$repo_ids、$start_date、$end_date，只需开启即可使用；自定义变量是账户定义的、由返回 value 和 label 列 SQL 查询支持的下拉筛选器。变量无法通过 CLI/API 管理，启用/禁用内置变量及增删改自定义变量必须在 Data Studio UI 中完成，但一旦在报告上启用，任何磁贴的 SQL（包括通过 dx studio reports create/update 设置的磁贴）都可引用它们。
- 失败检查处理：审查并解决实体的失败记分卡检查，包括分类、诊断、修复和重新评估。
- 快照分析：分析快照分数、驱动因素评论和 CSAT 评论。
三、使用方式
- 获取帮助：运行 dx --help 查看所有顶层命令；运行 dx <subcommand> --help 查看任意命令的用法，例如 dx auth --help、dx catalog --help、dx catalog entities --help、dx catalog entityTypes --help、dx scorecards --help、dx studio --help。所有命令都接受 --json 参数，以返回机器可读的 JSON 而非人类可读输出。
- 身份验证：首次使用 dx 子命令前，先运行 dx auth status 验证是否已认证。若返回错误或显示未登录，应停止并请用户通过 dx init 交互式登录，或通过 dx auth login 非交互式登录。若需要当前认证用户及其团队信息用于查询，运行 dx auth whoami，该命令调用 /auth.whoami 端点，显示账户名称、令牌类型，对于个人访问令牌还会显示用户姓名、邮箱及团队（含负责人和贡献者）；组织令牌的 user 和 team 返回 null。
- 回答 DX 产品问题：对于关于 DX 本身而非用户自身数据的问题（产品概念、设置/管理流程、连接器配置、故障排查/FAQ），应获取 https://docs.getdx.com/llms.txt 作为文档页面索引及其 Markdown URL，然后直接获取相关页面的 .md URL（而非 HTML 页面），例如 https://docs.getdx.com/onboarding/github-backfill.md，并依据获取的 Markdown 内容作答，而非凭记忆。若页面包含编号或顺序步骤，应按给定顺序执行，不跳过、不重排、不转述省略。
- 查看实体在全部记分卡上的表现：使用 dx catalog entities scorecards <identifier>。获取某实体的任务：使用 dx catalog entities tasks <identifier>。
四、适用场景 适用于需要以命令行方式管理 DX 平台软件目录、记分卡与工程数据的团队，例如批量维护实体与实体类型、通过 YAML 管理记分卡与检查项、创建和更新 Data Studio 报告、处理失败检查、分析快照与 CSAT 数据，以及查询 DX 产品本身的文档问题。
五、限制 所有命令均需身份验证。变量无法通过 CLI/API 管理，内置变量的启用/禁用与自定义变量的增删改必须在 Data Studio UI 中完成。组织令牌下 whoami 的 user 和 team 返回 null。关于收费、价格、平台支持范围等信息，资料中暂未提供。