From 45ba2273c9a989447e3238fdd3ac74e6e3f96b57 Mon Sep 17 00:00:00 2001 From: BruceL017 <253661133+BruceL017@users.noreply.github.com> Date: Mon, 13 Jul 2026 18:48:33 +0800 Subject: [PATCH] Add one-command quickstart --- .github/workflows/ci.yml | 13 +++++++++++++ README.md | 18 ++++++++++++++++++ README.zh-CN.md | 23 +++++++++++++++++++++++ 3 files changed, 54 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9faf6c4..5f9e14b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -9,6 +9,19 @@ permissions: contents: read jobs: + one-command-quickstart: + name: One-command quickstart + runs-on: macos-14 + + steps: + - uses: actions/checkout@v4 + + - name: Install uv + uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0 + + - name: Verify one-command quickstart + run: uvx --from . cleanapp --version + test-and-package: name: Python ${{ matrix.python-version }} on macOS runs-on: macos-14 diff --git a/README.md b/README.md index 29e238b..4f809d2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ CleanApp 是一款面向 macOS 的安全、透明、规则驱动卸载工具。它扫描桌面应用与常见开发工具,在删除前展示将要停止的进程、调用的包管理器和清理的路径,并且只有在用户明确确认后才会执行。 +## 一条命令运行(推荐) + +已安装 [uv](https://docs.astral.sh/uv/getting-started/installation/) 时,无需克隆仓库、创建虚拟环境或手动安装依赖: + +```bash +uvx --from git+https://github.com/clawdbot502/clean-cli cleanapp doctor +``` + +将最后的 `doctor` 换成 `list`、`rules` 或其他子命令即可直接使用。例如,安全预演 Cursor 清理: + +```bash +uvx --from git+https://github.com/clawdbot502/clean-cli cleanapp remove cursor --dry-run +``` + +`uvx` 会在隔离环境中运行 CleanApp,不会把它安装到全局 Python。没有安装 `uv` 时,请使用下方的手动安装流程。 + ## 能否克隆后直接使用? 可以,但运行环境必须满足以下条件: @@ -29,6 +45,8 @@ python3 -m venv .venv .venv/bin/cleanapp doctor ``` +不要跳过 Python 版本检查和 pip 升级。若旧版 pip 报错 `setup.py or setup.cfg not found`,说明它尚不支持本项目基于 `pyproject.toml` 和 Hatchling 的 editable install;确认 Python 为 3.11+ 后,重新执行 pip 升级和安装命令。 + 开发者可安装测试依赖: ```bash diff --git a/README.zh-CN.md b/README.zh-CN.md index 9c44778..dd3cb18 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -4,6 +4,22 @@ CleanApp 是一款运行于 macOS 终端的交互式软件卸载工具。它可 CleanApp 的重点不是“尽可能快地删除”,而是让卸载过程安全、透明、可确认、可扩展。 +## 一条命令运行(推荐) + +已安装 [uv](https://docs.astral.sh/uv/getting-started/installation/) 时,无需克隆仓库、创建虚拟环境或手动安装依赖: + +```bash +uvx --from git+https://github.com/clawdbot502/clean-cli cleanapp doctor +``` + +将最后的 `doctor` 换成 `list`、`rules` 或其他子命令即可直接使用。例如,安全预演 Cursor 清理: + +```bash +uvx --from git+https://github.com/clawdbot502/clean-cli cleanapp remove cursor --dry-run +``` + +`uvx` 会在隔离环境中运行 CleanApp,不会把它安装到全局 Python。没有安装 `uv` 时,请使用下方的手动安装流程。 + ## 主要功能 - 扫描 `/Applications` 和 `~/Applications` 中的 macOS 应用。 @@ -62,6 +78,13 @@ python3 -m venv .venv .venv/bin/python -m pip install -e . ``` +不要跳过 Python 版本检查和 pip 升级。若旧版 pip 报错 `setup.py or setup.cfg not found`,说明它尚不支持本项目基于 `pyproject.toml` 和 Hatchling 的 editable install;确认 Python 为 3.11+ 后,重新执行: + +```bash +.venv/bin/python -m pip install --upgrade pip +.venv/bin/python -m pip install -e . +``` + ## 快速开始 ### 查看本机软件