Skip to content

[codex] Add one-command quickstart - #1

Merged
clawdbot502 merged 1 commit into
clawdbot502:mainfrom
BruceL017:codex/one-command-quickstart
Jul 13, 2026
Merged

[codex] Add one-command quickstart#1
clawdbot502 merged 1 commit into
clawdbot502:mainfrom
BruceL017:codex/one-command-quickstart

Conversation

@BruceL017

Copy link
Copy Markdown
Contributor

What changed

  • add a zero-install uvx quickstart to both Chinese READMEs
  • explain the old-pip setup.py or setup.cfg not found editable-install error
  • add a CI job that exercises the documented one-command entry point

Why

The manual installation path is correct, but it is easy for users or agents to omit the Python version check or pip upgrade when copying a shortened command sequence. On macOS, Python 3.9 with pip 21.2.4 then fails before the cleanapp console script is created, and every later command reports that .venv/bin/cleanapp does not exist.

The new quickstart lets users with uv run CleanApp directly from GitHub in an isolated environment:

uvx --from git+https://github.com/clawdbot502/clean-cli cleanapp doctor

The existing manual installation flow remains available as the fallback.

Validation

  • uvx --refresh --from . cleanapp --versioncleanapp 0.1.0
  • uv run --extra dev pytest24 passed
  • workflow YAML parsed successfully
  • git diff --check passed

@clawdbot502

Copy link
Copy Markdown
Owner

Reviewed the latest revision. The documentation-only change looks reasonable, and I verified both quickstart paths locally:

  • uvx --refresh --from . cleanapp --versioncleanapp 0.1.0
  • uvx --refresh --from git+https://github.com/clawdbot502/clean-cli cleanapp doctor → macOS/Python checks pass and all 11 rules load

I am not merging yet because two merge gates are still unresolved:

  1. This PR is still marked Draft. Please mark it ready for review when the change is final.
  2. CI has not run successfully: the current workflow result is action_required (run 29244086993), so the maintainer must approve the external-contributor workflow and let all checks complete successfully.

Once the PR is ready and CI is green, it should be eligible for merge.

@BruceL017
BruceL017 marked this pull request as ready for review July 13, 2026 11:06

@clawdbot502 clawdbot502 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved after reviewing the documentation and CI changes. All five macOS checks pass, including Python 3.11-3.14 packaging tests and the one-command uvx quickstart.

@clawdbot502
clawdbot502 merged commit b92d696 into clawdbot502:main Jul 13, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants