@ramp/cli

中文文档
0.2.90发布于 2026/11/02MITCommonJS构建来源已验证

安装并启动独立的Ramp CLI

中文使用文档
文档目录8 节
  1. 安装
  2. 快速入门
  3. 命令
  4. 资源
  5. 全球旗帜
  6. 工具旗帜
  7. 代理模式
  8. 许可证

@ramp / cli

CLI用于Ramp的开发者API。通过OAuth认证,管理费用,批准账单,预订旅行等-从您的终端或人工智能代理。

安装

npm install -g @ramp/cli

或者直接运行而不进行全局安装:

npx @ramp/cli --help

需要Node.js 22+和npm 10+(不需要Python)。支持的平台:macOS (Apple Silicon & Intel), Linux (glibc x64 & arm64)和Windows (x64)。

关于单命令匝道路由器设置,请参见 @ramp/router (npx @ramp/router)。

快速入门

ramp auth login                              # OAuth via browser
ramp users me                                # Current user details
ramp bills search --query "Acme"             # Search bills by vendor name
ramp cards list                              # List your cards (card_state shows ACTIVE)
ramp transactions list --transactions_to_retrieve my_transactions
ramp transactions list --transactions_to_retrieve my_transactions --from_date 2025-01-01
ramp transactions list --transactions_to_retrieve my_transactions --rationale "Monthly review" --agent  # JSON output for scripting
ramp router                                  # Open the Router workspace
ramp update                                  # Update to the latest release

命令

命令描述
auth登录,注销,检查状态
config获取/设置CLI配置
env显示或设置默认环境(沙箱/生产)
profile显示、列出或切换凭证配置文件
router连接编码代理,管理密钥和策略
applications申请一个Ramp帐户
skills浏览并安装代理技能说明
update更新CLI到最新版本
feedback提交对CLI的反馈

资源

12种资源,每种资源都有自己的工具:

资源工具
accountingcategories, category-options
billssearch, get, draft, pending, approve, attachments
cardslist, activate, lock (别名也下 funds)
fundslist, activate, creds, lock
generalcomment, explain, help-center
purchase-orderssearch, get
receiptsupload, attach
reimbursementslist, pending, submit, approve, edit
requestspending, approve
transactionslist, get, approve, edit, missing, flag-missing, explain-missing, memo-suggestions, trips
travellist, create, bookings, locations
userslist, me, org-chart

用法: ramp <resource> <tool> [OPTIONS]

全球旗帜

国旗描述
--env, -eproduction (默认)或 sandbox
--output, -o输出格式: json 或者 table
--agent机器可读JSON输出(管道时的默认值)
--human人类可读的表输出(终端中的默认值)
--wide在表输出中显示所有列
--quiet, -q抑制进度输出
--no-input禁用交互式提示(用于CI/脚本)

工具旗帜

国旗描述
--json TEXT原始JSON请求体(绕过标志)
--dry_run, -n未发送打印请求
--page_size N每页结果
--next_page_cursor从以前的响应恢复分页

运行 ramp <resource> <tool> --help 查看某个工具的所有可用标志。

代理模式

--agent 输出用于脚本和AI代理使用的JSON。管 jq 处理:

ramp transactions list --transactions_to_retrieve my_transactions --rationale "Monthly review" --agent | jq '.data[0]'
ramp users me --rationale "Look up my user ID" --agent | jq '.data[0].user_id'

许可证

MIT -见 https://github.com/ramp-public/ramp-cli 获取完整的文档和源代码。

版本与发布记录

@ramp/cli 共发布 26 个版本,首次发布于 2026/10/16;过去 12 个月发布了 26 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.90latest2026/11/021 天前
0.2.892026/10/303 天前
0.2.882026/10/304 天前
0.2.872026/10/294 天前
0.2.862026/10/295 天前
0.2.852026/10/295 天前

关于 @ramp/cli 的常见问题

@ramp/cli 是什么?

安装并启动独立的Ramp CLI

如何安装 @ramp/cli?

在项目目录运行 npm install @ramp/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ramp,可以用 npx ramp 直接运行。

@ramp/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/ramp__cli 是否存在。

@ramp/cli 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@ramp/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@ramp/cli 可以商用吗?

@ramp/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@ramp/cli 还在维护吗?

最新版本 0.2.90 发布于 2026/11/02(1 天前);至今共发布 26 个版本,其中过去 12 个月发布了 26 个;首次发布于 2026/10/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。