135 lines
3.2 KiB
Markdown
135 lines
3.2 KiB
Markdown
|
|
# WinShell
|
|
|
|
WinShell 是一个使用 Rust 实现的命令行工具集合，旨在提供在 Windows 环境下类似于 Linux 系统常用命令的功能。这些命令包括 `ls`、`mv`、`mkdir`、`rm`、`cat`、`cp`、`tail`、`top` 等，方便在 Windows 平台上执行类似 Unix 风格的命令操作。
|
|
|
|
## 项目结构
|
|
|
|
项目按照不同类型的命令进行分类，使用子目录来组织各类操作。目录结构如下：
|
|
|
|
```
|
|
WinShell/
|
|
├── src/
|
|
│ ├── commands/
|
|
│ │ ├── directory_ops/ # 文件目录相关命令
|
|
│ │ │ ├── mod.rs
|
|
│ │ │ ├── mkdir.rs
|
|
│ │ ├── file_ops/ # 文件操作相关命令
|
|
│ │ │ ├── mod.rs
|
|
│ │ │ ├── cp.rs
|
|
│ │ │ ├── ls.rs
|
|
│ │ │ ├── mv.rs
|
|
│ │ │ ├── mkdir.rs
|
|
│ │ │ ├── rm.rs
|
|
│ │ │ ├── cat.rs
|
|
│ │ │ ├── cp.rs
|
|
│ │ │ └── tail.rs
|
|
│ │ │ └── touch.rs
|
|
│ │ │ └── wget.rs
|
|
│ │ ├── system_ops/ # 系统操作相关命令
|
|
│ │ │ └── top.rs
|
|
│ │ └── mod.rs # 命令模块定义
|
|
│ ├── main.rs # 主程序入口
|
|
├── Cargo.toml # Cargo 配置文件
|
|
└── README.md # 项目说明文档
|
|
```
|
|
|
|
## 安装与构建
|
|
|
|
### 前置条件
|
|
|
|
- 需要安装 [Rust 编译工具链](https://www.rust-lang.org/)
|
|
|
|
### 构建步骤
|
|
|
|
1. 克隆项目到本地：
|
|
|
|
```bash
|
|
git clone https://gitee.com/zhub_dev/WinShell.git
|
|
cd WinShell
|
|
```
|
|
|
|
2. 构建项目：
|
|
|
|
```bash
|
|
cargo build --release
|
|
```
|
|
|
|
3. 运行项目：
|
|
|
|
```bash
|
|
cargo run -- <command> [args...]
|
|
```
|
|
|
|
例如，列出当前目录的文件：
|
|
|
|
```bash
|
|
cargo run -- ls
|
|
```
|
|
|
|
## 使用说明
|
|
|
|
WinShell 提供以下命令，支持常见的文件和系统操作：
|
|
|
|
### 文件操作命令
|
|
|
|
- `cp`：复制文件或目录
|
|
- `ls`：列出文件和目录
|
|
- `mv`：移动或重命名文件/目录
|
|
- `mkdir`：创建目录
|
|
- `rm`：删除文件或目录
|
|
- `cat`：显示文件内容
|
|
- `tail`：查看文件末尾内容
|
|
- `touch`：创建一个空文件
|
|
- `wget`：下载文件
|
|
|
|
### 系统操作命令
|
|
|
|
- `top`：显示系统的进程列表
|
|
- `kill`：终止一个进程
|
|
|
|
### 示例（命令调试模式）
|
|
|
|
- 列出当前目录的文件（`ls` 命令）：
|
|
|
|
```bash
|
|
cargo run -- ls
|
|
```
|
|
|
|
- 删除文件（`rm` 命令）：
|
|
|
|
```bash
|
|
cargo run -- rm <文件名>
|
|
```
|
|
|
|
- 显示文件内容（`cat` 命令）：
|
|
|
|
```bash
|
|
cargo run -- cat <文件名>
|
|
```
|
|
|
|
- 复制文件（`cp` 命令）：
|
|
|
|
```bash
|
|
cargo run -- cp <源文件> <目标文件>
|
|
```
|
|
### 安装 WinShell 命令到 windows
|
|
`（待补充）`
|
|
|
|
## 参数说明
|
|
|
|
每个命令支持的参数有所不同，以下是一些常用的选项：
|
|
|
|
- `ls -l`：以详细模式列出文件
|
|
- `tail -n <行数>`：显示文件的最后几行
|
|
- `top -n <显示进程数>`：显示指定数量的进程
|
|
|
|
## 注意事项
|
|
|
|
1. 某些命令可能需要管理员权限才能执行。
|
|
2. 目前只支持在 Windows 系统上运行。
|
|
|
|
## 贡献
|
|
|
|
欢迎对 WinShell 项目进行贡献，提交 Pull Request 或 Issue。
|