Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Repository Guidelines
# Repository Guidelines

## 项目结构与模块组织
- Rust 核心:入口在 `src/bin/ziro.rs`;`src/cli/`(`args.rs` 参数定义,`handlers.rs` 命令分发);`src/core/`(`port/` 端口扫描,`process/` 进程终止,`fs_ops/` 文件删除与安全校验,`top/` 监控);`src/platform/`(`term.rs` 终端/环境配置,`encoding.rs` Windows UTF-8 初始化);`src/ui/`(`render.rs` 输出、交互,`theme.rs` 颜色,`icons.rs` 图标)。
- Node 分发层:`bin/ziro.js` 作为 npm 启动代理,`scripts/install.js`+`detect-platform.js` 下载发布产物,`package.json` 声明元数据。
- 发行/工具:`target/` 存放构建产物(已忽略),`.github/` 存放 CI/发布配置。
- **文档说明**:详细文档存放在 `docs/zh/` (中文) 和 `docs/en/` (英文) 目录下,按模块(安装、使用、开发、贡献)拆分。

## 构建、测试与开发命令
- `cargo build --release`:生成优化二进制到 `target/release/ziro`。
Expand Down
224 changes: 0 additions & 224 deletions README.en.md

This file was deleted.

23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,20 @@

A fast, cross-platform port management tool

一个快速、跨平台的端口管理工具

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Crates.io](https://img.shields.io/crates/v/ziro.svg)](https://crates.io/crates/ziro)
[![npm](https://img.shields.io/npm/v/@ithinku/ziro.svg)](https://www.npmjs.com/package/@ithinku/ziro)

**Choose Language / 选择语言:**

[🇺🇸 English](README.en.md) | [🇨🇳 简体中文](README.zh.md)
[🇺🇸 English](README.md) | [🇨🇳 简体中文](README.zh.md)

</div>

## Introduction

Ziro is a powerful command-line tool for quickly finding and managing processes that occupy ports. Supports Windows, Linux, and macOS platforms.

## Quick Start

### Install
Expand All @@ -30,21 +32,24 @@ cargo install ziro
npm install -g @ithinku/ziro
```

### Usage
### Basic Usage

```bash
# Find process on port 8080
ziro find 8080

# Kill process on port 8080
ziro kill 8080
```

# List all ports
ziro list
## Documentation

# Check file/directory lock
ziro who C:\path\file.txt
```
For full details, please refer to our detailed documentation:

- [Installation Guide](docs/en/01-installation.md)
- [Usage Guide](docs/en/02-usage.md)
- [Development Guide](docs/en/03-development.md)
- [Contributing Guide](docs/en/04-contributing.md)

---

Expand Down
Loading
Loading