# IntraNetSeeker

**Repository Path**: enthusiasm23/IntraNetSeeker

## Basic Information

- **Project Name**: IntraNetSeeker
- **Description**: IntraNetSeeker 是一款内部网络搜索和助手工具，旨在使用户能够在企业内部网络环境中快速定位文件、执行传输操作以及使用其他便捷工具。
- **Primary Language**: Shell
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://gitee.com/enthusiasm23/IntraNetSeeker
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-08-28
- **Last Updated**: 2024-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 简易脚本, 快捷工具, 内网助手

## README

![IntraNetSeeker_logo](images/IntraNetSeeker_logo.jpg)

<h1 align="center">IntraNetSeeker</h1>

<p align="center">
    中文文档 | <a href="README.en.md">English Documentation</a>
</p>

---

## 介绍
**IntraNetSeeker** 是一款内部网络搜索和助手工具，旨在使用户能够在企业内部网络环境中快速定位文件、执行传输操作以及使用其他便捷工具。

---

## 软件架构

1. **主脚本 ([intraNetSeeker](intraNetSeeker))**:
   - 主脚本充当整个应用程序的入口点，负责协调各个组件并执行搜索、传输、计算等操作。
   - intraNetSeeker 通过引用 [scripts](scripts) 文件夹中的脚本来执行特定任务，例如关键词搜索和文件传输。

2. **脚本文件夹 ([scripts](scripts))**:
   - 该文件夹包含用于辅助主脚本的多种脚本文件。
   - 应用程序使用的脚本包括：
     - [`seek.sh`](scripts/seek.sh): 用于执行搜索和传输操作的脚本。
     - [`md5c.sh`](scripts/md5c.sh): 用于计算文件的MD5哈希值的脚本。
     - [`fileCombiner.py`](scripts/fileCombiner.py): 用于合并文件的脚本。
     
3. **配置和模板文件 ([extdata](extdata))**:
   - [extdata](extdata) 文件夹包含了应用程序的配置和模板文件。
   - 配置文件:
     - [`config.ini`](extdata/config.ini): 存储应用程序的配置信息，包括脚本版本信息和第三方软件默认路径等。
   - 模板文件:
     - [`seek_servers_template.txt`](extdata/seek_servers_template.txt): 用于存储服务器信息的模板文件。当调用 [seek.sh](scripts/seek.sh) -s 参数时使用该模板文件。
     - [`seek_dirs_template.txt`](extdata/seek_dirs_template.txt):用于存储搜索目录路径的模板文件。当调用[seek.sh](scripts/seek.sh) -d 参数时使用该模板文件。

4. **图像文件夹 ([images](images))**:
   - 该文件夹包含应用程序所需的图像资源。
   - 例如，[`IntraNetSeeker_logo.jpg`](images/IntraNetSeeker_logo.jpg) 是应用程序的标志性 Logo 图片。

5. **其他文件**:
   - [`LICENSE`](LICENSE): 包含应用程序的许可证信息。
   - [中文文档](README.md) 和 [English Documentation](README.en.md): 包含应用程序的详细文档和说明。

以上软件架构描述简明扼要地介绍了项目的主要组件和文件的作用。具体的实现和交互逻辑将根据代码的实际实现和项目目标而定。

---

## 安装教程

1. **克隆仓库**:
   - 打开终端或命令行界面。
   - 运行以下命令以克隆 "IntraNetSeeker" 仓库到本地计算机：
     ```
     git clone https://gitee.com/enthusiasm23/IntraNetSeeker.git
     ```

2. **进入仓库目录**:
   - 使用以下命令进入 "IntraNetSeeker" 仓库目录：
     ```
     cd IntraNetSeeker
     ```

3. **将仓库目录路径添加到环境变量**:
   - 为了能够在任何地方使用脚本，可以将仓库目录路径添加到环境变量中。
   - 编辑shell 配置文件（如 `~/.bashrc` 或 `~/.bash_profile` 对于 Bash shell）并添加以下行：
     ```
     export PATH="$PATH:/path/to/IntraNetSeeker"
     ```
    将 `/path/to/IntraNetSeeker` 替换为 "IntraNetSeeker" 仓库目录的实际路径。
   - 在终端中运行以下命令以使更改生效：
     ```
     source ~/.bashrc
     ```
     或
     ```
     source ~/.bash_profile
     ```

4. **运行脚本**:
   - "IntraNetSeeker" 已经安装完成，可以在终端的任何地方运行主脚本 ([intraNetSeeker](intraNetSeeker)) 来使用软件。
   - 注意：如果使用不同的 shell，请编辑相应的配置文件以添加路径到环境变量。

---

## 使用说明

1. **运行 "IntraNetSeeker"**：
    - 在终端中执行以下命令以启动 "IntraNetSeeker" 软件：
    ```bash
    intraNetSeeker
    ```

2. **获取帮助信息**：
    - 若要获取有关软件的帮助信息，请运行以下命令：
    ```bash
    intraNetSeeker -h
    ```

3. **使用 "seek" 命令**：
    - "seek" 命令用于执行搜索和文件传输操作。以下是使用命令的示例格式：
    ```bash
    intraNetSeeker seek -k "关键词" -d "搜索目录" -s "系统信息"
    ```
    - 若要查看更多选项和有关批量搜索的帮助信息，请运行以下命令：
    ```bash
    intraNetSeeker seek -h
    ```

    **提示信息**：
    - 默认情况下，"seek" 命令会使用一个txt文件传入的服务器信息。您可以修改模板文件 [extdata/seek_servers_template.txt](extdata/seek_servers_template.txt) 中的内容，并将文件名更改为 "seek_servers.txt"，或者您可以使用 "-s" 选项传递自定义的服务器信息文件路径。

    - 此外，"seek" 命令还支持不同的搜索方式：
        - 使用 "-k" 选项可以直接传入搜索关键词，传入格式请参考帮助信息。
        - 使用 "-i" 选项可以传入关键词文件，文件格式为一行一个关键词。注意，"-i" 和 "-k" 只能二选一使用。
        - 使用 "-d" 选项可以传入搜索路径文件，每行包含一个搜索目录的信息。

4. **使用其他命令**：
    除了 "seek" 命令外，软件还支持其他命令，如 "md5c" 和 "combine"等。可以运行相应的命令，并使用 `-h` 参数来获取更多的帮助信息。

---

## 参与贡献

我们欢迎您参与 "IntraNetSeeker" 项目的贡献。以下是贡献的简要步骤：

1. **Fork 本仓库**:
   - 点击页面右上角的 "Fork" 按钮，将本仓库复制到您自己的 GitHub 账户中。

2. **新建 Feat_xxx 分支**:
   - 在您的仓库中创建一个新的分支，以便您可以独立开发新功能或修复问题。请为分支命名以反映您的工作内容，例如 `feat-new-feature`。

3. **提交代码**:
   - 在您的分支上进行编码，实现所需的更改或添加新功能。
   - 在提交代码之前，请确保代码符合项目的编码准则，并包含有关所做更改的清晰描述。

4. **新建 Pull Request**:
   - 当您的工作完成并且准备合并更改时，请创建一个 Pull Request（PR）。
   - 在 PR 描述中，清晰地说明您所做的更改以及其目的。

我们的团队将会审查您的贡献，并尽快合并适当的更改。感谢您对 "IntraNetSeeker" 项目的支持和贡献！

---

## 协议

本项目采用 [MIT 许可协议](https://opensource.org/licenses/MIT)。

MIT License 是一种简洁而宽松的许可协议，它仅要求保留版权和许可通知。根据该许可协议，您有以下权利：

- **商业使用**：可以在商业项目中使用此软件。
- **修改**：可以修改、衍生或扩展此软件。
- **分发**：可以在任何地方分发此软件，包括在自己的项目中。
- **私人使用**：可以在个人项目或内部组织中使用此软件。

MIT License的特点是非常灵活，允许您自由使用、修改和分发软件，而无需公开源代码。

我们鼓励所有用户遵守MIT许可协议，并感谢您的合作和支持！

---

## 致谢

我们要由衷感谢所有为本项目做出贡献的个人和团队，以及那些提供支持、建议、代码或资源的人。同时，我们也感谢广大用户和社区成员，您的支持和使用对于项目的成功至关重要。

特别感谢以下贡献者（按字母顺序排列）：

- [shinevalora](https://gitee.com/shinevalora)

如果您有兴趣参与或贡献本项目，请查看 [参与贡献](#参与贡献) 部分以获取更多信息。