业务
此软件包是一个简单的 JavaScript 包 1 口语CLI它为大部分的CLI提供了方法 命令,并且在许多情况下扩展了CLI使用 生物鉴别技术 你正在建造的基于节点的应用程序。 它还包括了TypeScript声明.
安装
使用 Yarn 安装 :
yarn add @1password/op-js
或利用国家预防机制:
npm install @1password/op-js
使用量
安装后,您可以开始使用命令方法:
import { version, item, connect } from "@1password/op-js";
// Some command functions may be directly imported
version();
// But most exist on their parent command's object
item.get("x1oszeq62e2ys32v9a3l2sgcwly");
// And sub-commands are nested even further
connect.group.revoke({
group: "MyGroup",
allServers: true,
});
CLI把旗帜当作 kebab-case然而,为了更好地与《联合来文》的目标公约保持一致,应当提供所有旗帜,因为 camelCase。 。 。 .
旗帜
所有指挥方法支助 全局命令旗,以及他们自己的旗帜,但这个软件包也提供了一个帮助器来设置全球指令旗,而你不需要每次使用. 例如:
import { setGlobalFlags } from "@1password/op-js";
setGlobalFlags({
account: "example.1password.com",
});
请注意,你不应该试图设置 --format 旗子, 将它设置在引擎盖下 json 用于返回 JSON 格式的所有命令; 否则它是一个字符串响应.
验证CLI
由于这个软件包依赖于"1Password CLI",所以由用户来安装,而类型可能取决于特定版本. 您的应用程序可以调用一个功能来验证用户在特定版本安装了CLI:
import { validateCli } from "@1password/op-js";
validateCli().catch((error) => {
console.log("CLI is not valid:", error.message);
});
// defaults to the recommended version, but you can supply a semver:
validateCli(">=2.3.1").catch((error) => {
console.log("CLI is not valid:", error.message);
});
认证
默认 op-js 它使用系统认证(例如生物鉴别技术),但也支持通过 连接服务器 或者说 服务账户。 。 。 .
连接
如果您已经设置了连接服务器, 您可以提供您的主机和信使 :
import { setConnect } from "@1password/op-js";
setConnect("https://connect.myserver.com", "1kjhd9872hd981865s");
或者在执行使用代码时使用环境变量 op-js数字 :
OP_CONNECT_HOST=https://connect.myserver.com
OP_CONNECT_TOKEN=1kjhd9872hd981865s
服务账户
如果你使用服务账户,你可以提供你的代币:
import { setServiceAccount } from "@1password/op-js";
setServiceAccount("1kjhd9872hd981865s");
或者在执行使用代码时使用环境变量 op-js数字 :
OP_SERVICE_ACCOUNT_TOKEN=1kjhd9872hd981865s
可用的命令和函数
大约有70个命令可供使用,所以鼓励您检查主命令 index.ts 以更好地了解可用的文件。 一般来说,这里是您可以导入的顶级命令/命名空间:
version- 获取当前版本的CLIinject- 向配置文件输入机密read- 通过秘密参考读取秘密account- 管理账户document- 在金库管理文档eventsApi- 创建事件 API 集成符connect- 管理连接组、服务、信使和金库item- 管理金库物品和模板vault- 管理账户金库user- 管理账户用户group- 管理团体及其用户whoami- 详细了解认证账户
贡献和反馈
如果你发现一个问题,你想报告 或者有反馈,请 提交新问题。 。 。 .
🧑💻 如果您想为该项目捐款,请首先提交或评论 问题 这样我们就能追踪工作 参见 贡献文件 发展设置指南.
QQ 分享您的反馈并连接到开发者产品团队 1Password 开发者 Slack 工作空间.
许可证
麻省理工学院