# @1password/op-js 中文文档

规范地址：https://npmcn.com/package/%401password/op-js/

版本：0\.1\.13
npm 元数据更新时间：2025-08-25T18:18:31.323Z
中文译文更新时间：2026-11-05T17:33:11.520Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%401password/op-js
原文对照：https://npmcn.com/package/%401password/op-js/?lang=original
源码仓库：https://github.com/1Password/op-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：52.7 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-06-02T12:51:42.469Z
- 最新版本发布：2024-06-21T15:41:44.681Z
- 近 30 天下载量：262208（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 0 个）

## 中文简介

1Password CLI的打入JS包装器

## 安装

```sh
npm install @1password/op-js
```

也可以使用：`pnpm add @1password/op-js`、`yarn add @1password/op-js`、`bun add @1password/op-js`

## README

# 业务

此软件包是一个简单的 JavaScript 包 [1 口语CLI](https://developer.1password.com/docs/cli)它为大部分的CLI提供了方法 [命令](https://developer.1password.com/docs/cli/reference),并且在许多情况下扩展了CLI使用 [生物鉴别技术](https://developer.1password.com/docs/cli/about-biometric-unlock) 你正在建造的基于节点的应用程序。 它还包括了TypeScript声明.

## 安装

使用 Yarn 安装 :

```shell
yarn add @1password/op-js
```

或利用国家预防机制:

```shell
npm install @1password/op-js
```

## 使用量

安装后,您可以开始使用命令方法:

```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`。 。 。 .

### 旗帜

所有指挥方法支助 [全局命令旗](https://developer.1password.com/docs/cli/reference#global-flags),以及他们自己的旗帜,但这个软件包也提供了一个帮助器来设置全球指令旗,而你不需要每次使用. 例如:

```js
import { setGlobalFlags } from "@1password/op-js";

setGlobalFlags({
    account: "example.1password.com",
});
```

请注意,你不应该试图设置 `--format` 旗子, 将它设置在引擎盖下 `json` 用于返回 JSON 格式的所有命令; 否则它是一个字符串响应.

### 验证CLI

由于这个软件包依赖于"1Password CLI",所以由用户来安装,而类型可能取决于特定版本. 您的应用程序可以调用一个功能来验证用户在特定版本安装了CLI:

```js
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` 它使用系统认证(例如生物鉴别技术),但也支持通过 [连接服务器](https://developer.1password.com/docs/connect) 或者说 [服务账户](https://developer.1password.com/docs/service-accounts)。 。 。 .

**连接**

如果您已经设置了连接服务器, 您可以提供您的主机和信使 :

```
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`](https://npmcn.com/package/%401password/op-js/src/index.ts) 以更好地了解可用的文件。 一般来说,这里是您可以导入的顶级命令/命名空间:

-   `version` - 获取当前版本的CLI
-   `inject` - 向配置文件输入机密
-   `read` - 通过秘密参考读取秘密
-   `account` - 管理账户
-   `document` - 在金库管理文档
-   `eventsApi` - 创建事件 API 集成符
-   `connect` - 管理连接组、服务、信使和金库
-   `item` - 管理金库物品和模板
-   `vault` - 管理账户金库
-   `user` - 管理账户用户
-   `group` - 管理团体及其用户
-   `whoami` - 详细了解认证账户

## 贡献和反馈

如果你发现一个问题,你想报告 或者有反馈,请 [提交新问题](https://github.com/1Password/op-js/issues/new)。 。 。 .

🧑‍💻 如果您想为该项目捐款,请首先提交或评论 [问题](https://github.com/1Password/op-js/issues) 这样我们就能追踪工作 参见 [贡献文件](https://github.com/1Password/op-js/blob/main/CONTRIBUTING.md) 发展设置指南.

QQ 分享您的反馈并连接到开发者产品团队 [1Password 开发者 Slack](https://developer.1password.com/joinslack) 工作空间.

## 许可证

麻省理工学院

## 常见问题

### @1password/op-js 是什么？

1Password CLI的打入JS包装器

### 如何安装 @1password/op-js？

在项目目录运行 npm install @1password/op-js，或使用 pnpm add / yarn add / bun add。

### @1password/op-js 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @1password/op-js 支持 ESM 还是 CommonJS？

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

### @1password/op-js 可以商用吗？

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

### @1password/op-js 的下载量有多少？

根据 npm 官方下载统计，@1password/op-js 在 2026/10/05 – 2026/11/03 这 30 天内被下载 262,208 次，日均约 8,740 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @1password/op-js 还在维护吗？

最新版本 0\.1\.13 发布于 2024/06/21（2 年前）；至今共发布 19 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/06/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。