OneUptime CLI 认证完整指南：登录、上下文切换与凭据解析机制

可观测性后端运维前端云原生微服务AI Agent【免费下载链接】oneuptimeComplete open-source monitoring and observability platform.项目地址https://gitcode.com/GitHub_Trending/on/oneuptime点击查看免费下载OneUptime CLI 支持通过 API Key 与 OneUptime 实例完成认证并提供命名上下文Context、环境变量、命令行参数三种互补的凭据注入方式。本文以 CLI 认证文档仓库同时维护 法文版 等多语言版本为主线结合 packages/CLI 包的源码实现完整讲解oneuptime login、oneuptime context、oneuptime whoami的用法、四级凭据解析优先级以及底层配置文件格式与安全策略。读完本文你将能在多环境生产/预发/开发之间安全、高效地使用 OneUptime CLI 管理资源。快速开始使用 API Key 登录登录是使用 OneUptime CLI 的第一步。CLI 通过 API Key 与你的 OneUptime 实例建立认证关系执行命令oneuptime login api-key instance-url参数说明参数说明api-key你的 OneUptime API Key例如sk-your-api-keyinstance-url你的 OneUptime 实例地址例如https://oneuptime.com选项选项说明--context-name name为此登录会话命名的上下文名称默认default从源码看login命令定义于 ConfigCommands.ts它将instance-url尾部多余的斜杠去除instanceUrl.replace(/\/$/, )后与 API Key 一起构造成一个CLIContext对象写入配置并立刻将其设为当前上下文。登录成功后终端会显示Logged in successfully. Context name is now active.。典型示例# 使用默认上下文登录 oneuptime login sk-abc123 https://oneuptime.com # 使用命名上下文登录 oneuptime login sk-abc123 https://oneuptime.com --context-name production # 同时配置多个环境 oneuptime login sk-prod-key https://oneuptime.com --context-name production oneuptime login sk-staging-key https://staging.oneuptime.com --context-name staging上下文管理在多环境之间切换上下文Context机制允许你将多套 OneUptime 环境的凭据例如生产、预发、开发分别保存并在任意时刻一键切换避免反复输入 API Key。列出全部上下文oneuptime context list该命令以表格形式展示所有已配置的上下文当前激活的上下文行首以*标记。实现上context list调用ConfigManager.listContexts()见 ConfigManager.ts为每个上下文附加isCurrent布尔标记再由cli-table3渲染为*、名称、URL 三列ConfigCommands.ts。若尚未配置任何上下文会提示先运行oneuptime login。切换当前上下文oneuptime context use name切换后后续所有命令都会使用该上下文中保存的实例地址与 API Key。# 切换到预发环境 oneuptime context use staging # 切换到生产环境 oneuptime context use production切换操作对应ConfigManager.setCurrentContext(name)ConfigManager.ts若目标上下文不存在会抛出Context name does not exist.错误并退出。查看当前上下文oneuptime context current输出当前激活上下文的名称、实例 URL以及脱敏后的 API Key。脱敏规则定义于 ConfigCommands.ts当 Key 长度大于 8 时仅保留前 4 位与后 4 位中间以****填充长度不足 8 时整体显示为****。例如sk-abcd****wxyz。删除上下文oneuptime context delete name删除指定上下文。其底层逻辑ConfigManager.removeContext(name)ConfigManager.ts包含一个细心的行为如果被删除的上下文恰好是当前上下文CLI 会自动切换到剩余上下文中第一个若已无任何上下文则当前上下文重置为空。这一设计保证了删除操作后 CLI 始终处于一个可预期的状态。凭据解析优先级当执行资源类命令如oneuptime incident list时CLI 会按如下顺序解析凭据取第一个可用的来源CLI 参数--api-key与--url——优先级最高环境变量ONEUPTIME_API_KEY与ONEUPTIME_URL命名上下文通过--context参数指定当前上下文读取已保存的配置文件这一优先级顺序在 ConfigManager.ts 的getResolvedCredentials()中逐一实现并且文档还强调了一个实用特性可以混合来源——例如用环境变量提供 API Key、同时用已保存的上下文提供 URL。源码对该场景有专门处理见 ConfigManager.ts当只设置了部分环境变量时会用当前上下文补齐缺失的另一半。方式一直接使用 CLI 参数oneuptime --api-key sk-abc123 --url https://oneuptime.com incident list--api-key与--url是注册在 CLI 入口的全局选项见 Index.ts可以放在子命令之前使用并覆盖配置中的任何值。方式二使用环境变量export ONEUPTIME_API_KEYsk-abc123 export ONEUPTIME_URLhttps://oneuptime.com oneuptime incident list设置后即可直接执行命令无需在每条命令中携带参数适合在 CI/CD 流水线或脚本中注入密钥。方式三指定命名上下文oneuptime --context production incident list--context全局选项Index.ts让你在不切换当前上下文的前提下临时使用指定上下文的凭据。若该上下文不存在会立即报错。验证认证状态whoami执行以下命令检查当前的认证状态oneuptime whoami输出内容包含实例 URL脱敏后的 API Key同样遵循前 4 位 **** 后 4 位的规则当前上下文名称仅当存在已保存的激活上下文时显示该命令实现在 UtilityCommands.ts它调用getResolvedCredentials()尝试解析凭据——注意这里同样会纳入--api-key、--url、--context等全局选项因此whoami展示的是实际生效的凭据来源。如果未能解析出任何凭据未登录、未设置环境变量会输出Not authenticated. Run oneuptime login to authenticate.的友好提示引导你执行oneuptime login。配置文件格式与安全策略所有登录的凭据都保存在用户主目录下的 JSON 配置文件中~/.oneuptime/config.json文件路径由 ConfigManager.ts 通过os.homedir()动态拼接保存时显式指定mode: 0o600ConfigManager.ts即仅当前用户可读写防止其他系统用户读取到明文 API Key。加载时若文件不存在或内容损坏非法 JSONload()会安全地回退到默认配置而不是抛错中断ConfigManager.ts这一容错行为在 ConfigManager.test.ts 中有对应测试用例覆盖。配置文件结构如下{ currentContext: production, contexts: { production: { name: production, apiUrl: https://oneuptime.com, apiKey: sk-... }, staging: { name: staging, apiUrl: https://staging.oneuptime.com, apiKey: sk-... } }, defaults: { output: table, limit: 10 } }各字段含义如下字段说明currentContext当前激活的上下文名称contexts.name每个命名上下文包含name、apiUrl、apiKey三个字段defaults.output默认输出格式table、json、wide默认tabledefaults.limit列表类命令的默认条数限制默认10defaults字段的类型定义可参考 CLITypes.ts。建议不要手动编辑该文件而是通过oneuptime login与oneuptime context命令管理以避免破坏 JSON 结构或权限位。认证凭据如何在请求中生效解析出的凭据最终由 ApiClient.ts 用于访问 OneUptime API。其关键细节是请求路由统一以/api前缀拼接例如list操作对应GET/POST /api/resource/get-listApiClient.tsAPI Key 通过名为APIKey的请求头携带同时声明Content-Type: application/json与Accept: application/jsonApiClient.ts若服务端返回错误响应非 2xxCLI 会抛出包含状态码与消息的API error (statusCode): message异常ApiClient.ts。也就是说无论你采用login保存上下文、环境变量还是命令行参数最终都会收敛为实例 URL API Key两组值并由同一套 HTTP 客户端完成认证请求——这也解释了为什么文档强调几种来源可以自由组合。常见问题与排错思路No credentials found. Run oneuptime login ...说明四层解析全部落空。优先检查是否已执行oneuptime login、ONEUPTIME_API_KEY/ONEUPTIME_URL是否已导出或当前上下文是否已被删除。Context xxx does not exist.--context指定的名称未在配置中登记可通过oneuptime context list核对名称拼写。想临时切换环境又不想影响默认环境使用--context name而非context use前者只对单条命令生效。担心密钥泄露配置文件以0600权限保存且context current与whoami输出均对 API Key 脱敏不要在脚本日志中直接打印--api-key参数。掌握login、context系列命令与四级凭据解析规则后你便可以在生产、预发、开发多套 OneUptime 环境之间无缝切换并结合环境变量将认证安全地嵌入自动化流程。更完整的命令列表如oneuptime resources、资源增删改查可继续查阅 CLI README 与 ConfigCommands.ts、UtilityCommands.ts 源码。赞分享可观测性后端运维前端云原生微服务AI Agent【免费下载链接】oneuptimeComplete open-source monitoring and observability platform.项目地址https://gitcode.com/GitHub_Trending/on/oneuptime点击查看免费下载相关推荐OneUptime CLI 认证体系详解login 登录、命名上下文与凭据解析优先级OneUptime CLI 认证体系详解login 登录、命名上下文与凭据解析优先级 OneUptime CLI oneuptime/cli 支持通过可观测性后端运维前端云原生微服务AI AgentOneUptime CLI 认证完全指南login、多环境 Context 与凭据解析机制OneUptime CLI 认证完全指南login、多环境 Context 与凭据解析机制 OneUptime 开源可观测性平台自带一套功能完整的命令行工具可观测性后端运维前端云原生微服务AI AgentOneUptime CLI 命令参考认证、上下文切换与全资源 CRUD 操作的完整指南OneUptime CLI 命令参考认证、上下文切换与全资源 CRUD 操作的完整指南 本文基于 OneUptime 仓库中 da 语言版本的 CLI 命令参可观测性后端运维前端云原生微服务AI Agent上一篇终极指南3步轻松解决Plandex DeepSeek模型合并冲突下一篇Taichi LLVM 稀疏运行时深度解析SNode 存储、回收式内存分配器与 GPU 垃圾回收创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考