2 个版本

0.5.1 2024年8月19日
0.5.0 2024年6月23日

#256 in 命令行工具

Download history 157/week @ 2024-06-21 7/week @ 2024-06-28 4/week @ 2024-07-05 138/week @ 2024-08-16

138 每月下载

MIT 许可证

125KB
3.5K SLoC

Run tests

syspass-cli

一个简单的命令行工具,用于与 sysPass 数据库交互。

sysPass 直观、安全的多用户密码管理器

功能

  • 支持 sysPass 2.1 和 3.2
    • 2.1 版本功能有限,因为 API 不支持所有功能,例如但不限于:
      • 更改密码
  • 搜索账户并查看其密码
  • 从命令行添加新条目并更改密码
  • 从命令行添加新类别
  • 从命令行添加新客户端

安装

从源代码安装

git clone https://github.com/ggnosh/syspass-cli.git
cd syspass-cli
cargo build --release
# cp target/release/syspass-cli somewhere

Cargo

如果您已经设置了 Rust 环境,您可以使用 cargo install 命令

cargo install syspass-cli

从发布版

https://github.com/ggnosh/syspass-cli/releases 下载二进制文件

配置

syspass-cli 将在 $(HOME)/.syspass/config.json 查找配置文件

注意 密码可以在 config.json 文件中以明文形式设置,或作为环境变量。如果没有找到 SYSPASS_PASSWORD,则 syspass-cli 将提示输入。

配置文件

$(HOME)/.syspass/config.json 创建配置文件

{
  "host": "https://example.org/api.php",
  "token": "AUTHORIZATION_TOKEN",
  "password": "PASSWORD",
  "verifyHost": true,
  "passwordTimeout": 15,
  "apiVersion": "SyspassV3"
}

如果 password 为空,则需要在需要时进行提示。

passwordTimeout 如果值为 0,则忽略此功能。否则,除非指定了 --showpassword 标志,否则将在给定秒数后清除剪贴板。

apiVersion 用于定义要使用哪个 API。支持值包括 SyspassV2SyspassV3。如果未定义值,则 syspass-cli 默认使用最新的 sysPass 版本。

用法文件

位于 $(HOME)/.syspass/usage.json

此文件用于排序最常用的账户。可以通过在账户搜索时使用 -u--disableusage 来禁用此行为。

用法

Usage: syspass-cli [OPTIONS] <COMMAND>

Commands:
  search, -s    Search for account password [aliases: find]
  edit, -e      Edit entity [aliases: change]
  remove, -r    Remove entity [aliases: delete]
  new, -n       Add a new entity [aliases: add]
  check-update  Update syspass-cli
  help          Print this message or the help of the given subcommand(s)

Options:
  -c, --config <FILE>  Sets a custom config file
  -d, --debug          Output debug information
  -q, --quiet          Do not output any message
  -v, --verbose        Output more information
  -h, --help           Print help
  -V, --version        Print version

依赖项

~14-33MB
~483K SLoC