StatiCrypt 项目使用教程

1. 项目的目录结构及介绍

StatiCrypt 是一个用于加密 HTML 文件的工具，其 GitHub 仓库的目录结构相对简单。以下是主要的目录和文件介绍：

staticrypt/
├── bin/
│   └── staticrypt.js
├── lib/
│   ├── cli.js
│   ├── encrypt.js
│   ├── index.js
│   └── password_template.html
├── test/
│   ├── cli.test.js
│   ├── encrypt.test.js
│   └── password_template.test.html
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md
└── staticrypt.json

• bin/：包含可执行文件 staticrypt.js，这是命令行工具的入口。
• lib/：包含主要的逻辑文件，如 cli.js（命令行接口）、encrypt.js（加密逻辑）和 password_template.html（密码输入模板）。
• test/：包含测试文件，用于确保代码的正确性。
• .gitignore 和 .npmignore：用于指定在版本控制和 npm 发布时忽略的文件。
• LICENSE：项目的开源许可证。
• package.json：项目的 npm 配置文件，包含依赖、脚本等信息。
• README.md：项目的说明文档。
• staticrypt.json：配置文件，用于存储加密时使用的盐值。

2. 项目的启动文件介绍

StatiCrypt 的启动文件是 bin/staticrypt.js。这个文件是命令行工具的入口点，负责解析命令行参数并调用相应的逻辑。

#!/usr/bin/env node

const cli = require('../lib/cli');
cli.run();

• #!/usr/bin/env node：指定使用 Node.js 运行此脚本。
• const cli = require('../lib/cli')：引入 lib/cli.js 文件，这是命令行接口的主要逻辑。
• cli.run()：调用 cli 模块的 run 方法，开始执行命令行工具。

3. 项目的配置文件介绍

StatiCrypt 的配置文件是 staticrypt.json。这个文件用于存储加密时使用的盐值，确保“记住我”功能在多次加密时保持一致。

{
  "salt": "your-salt-value"
}

• salt：用于加密的盐值，确保密码哈希的一致性。

配置文件的路径可以通过命令行参数 --config 指定，如果不指定，默认会在当前目录下查找 staticrypt.json 文件。

staticrypt <filename> --config path/to/staticrypt.json

通过以上介绍，您应该对 StatiCrypt 项目的目录结构、启动文件和配置文件有了基本的了解。希望这份教程能帮助您更好地使用和配置 StatiCrypt。