Skip to content

docs(cli): install pipefy-cli from PyPI instead of git+subdirectory - #372

Merged
gbrlcustodio merged 3 commits into
devfrom
chore/cli-pypi-install
Jul 7, 2026
Merged

docs(cli): install pipefy-cli from PyPI instead of git+subdirectory#372
gbrlcustodio merged 3 commits into
devfrom
chore/cli-pypi-install

Conversation

@gbrlcustodio

Copy link
Copy Markdown
Member

What

Addresses the reframed goal of #234: move the CLI install path off git+…#subdirectory=packages/cli references (with --with sibling pins) onto plain PyPI installs, mirroring what #368 did for the MCP server.

All four packages now publish to PyPI on every tag (#365), so pipefy-cli resolves pipefy and pipefy-auth transitively. Installs no longer pay a git clone plus build, and the manual --with chains are gone.

The .mcp.json / MCP-server half already landed in #368; this closes out the remaining CLI half.

Changes

  • commands/install.md (/pipefy:install): uv tool install --force pipefy-cli.
  • README.md, packages/cli/README.md, docs/MIGRATION.md: install snippets use uvx --from pipefy-cli pipefy … / uv tool install pipefy-cli, with the PyPI-resolution note (no --prerelease allow).
  • RELEASE.md: verification snippets move to PyPI (PEP 440 pins); removed the now-vestigial latest moving-tag step (nothing consumes @latest after the switch) and the non-installable repo-root git examples.
  • CHANGELOG.md: [Unreleased] entry for the cutover.

Two latent bugs fixed along the way: the console script is pipefy (not pipefy-cli), and dropping the global --prerelease allow per #368's 6debb7f8 (it lets transitive deps pull their own broken pre-releases).

Verification

  • uvx --from pipefy-cli pipefy --version, uv tool install pipefy-cli, and the pinned-prerelease forms all resolve from PyPI (0.3.0a1) with no git clone.
  • No git+…/ai-toolkit install refs or @latest moving-tag references remain outside CHANGELOG.md.

Closes #234.

Move the CLI install path off `uvx --from "git+...#subdirectory=packages/cli"`
with `--with` sibling pins onto plain PyPI installs, matching what #368 did for
the MCP server. PyPI now publishes every tag (#365), so `pipefy-cli` resolves
`pipefy` and `pipefy-auth` transitively and installs no longer pay a git clone
plus build.

- `/pipefy:install` runs `uv tool install --force pipefy-cli`.
- Root README, packages/cli/README, and docs/MIGRATION snippets use
  `uvx --from pipefy-cli pipefy ...` / `uv tool install pipefy-cli`.
- Correct the console-script name (`pipefy`, not `pipefy-cli`) and drop the
  global `--prerelease allow`, which would let transitive deps jump to their
  own pre-releases.
- RELEASE.md verification moves to PyPI (PEP 440 pins); remove the vestigial
  `latest` moving-tag step (nothing consumes `@latest` after the PyPI switch)
  and the non-installable repo-root git examples.
- Fix docs/MIGRATION stale claim that new versions ship only at v1.0.

Closes #234.
@gbrlcustodio
gbrlcustodio requested a review from adriannoes July 6, 2026 19:30
@gbrlcustodio gbrlcustodio self-assigned this Jul 6, 2026
@gbrlcustodio gbrlcustodio added the documentation Docs, skills, README, or in-repo guides only (no runtime change) label Jul 6, 2026
adriannoes
adriannoes previously approved these changes Jul 6, 2026

@adriannoes adriannoes left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Solid docs-only follow-up that completes the CLI install cutover #368 left open. All six touched files consistently move from git+…#subdirectory + --with chains to plain PyPI installs, fix the pipefy console-script name in uvx examples, and drop the obsolete latest moving-tag release step. I spot-checked PyPI installs locally (uvx --from pipefy-cli pipefy --version and uvx pipefy-mcp-server --help) — both resolve 0.3.0-alpha.1 without --prerelease allow, matching the documented behavior. CI lint + test are green.

What worked well

  • Mirrors the merged MCP PyPI pattern from #368 with the same --prerelease allow rationale.
  • Corrects the pipefy vs pipefy-cli entrypoint in documented uvx invocations.
  • Removes vestigial @latest / moving-tag release mechanics from RELEASE.md.
  • Thorough CHANGELOG entry ties the cutover to #234 and #368.

Also noted (non-blocking)

  • README.md still labels v0.2.0-beta.* as the "current beta line" in the install callout while the pin example uses 0.3.0a1; consider aligning that sentence when convenient.

@gbrlcustodio

Copy link
Copy Markdown
Member Author

Fixed in bdb6537: the callout was doubly stale, so I updated it to the current pre-release line v0.3.0-alpha.* (first tag v0.3.0-alpha.1), which now matches the 0.3.0a1 pin example. Reflects the move from the beta to the alpha line too.

@gbrlcustodio
gbrlcustodio requested a review from adriannoes July 7, 2026 20:32

@adriannoes adriannoes left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Re-reviewed after the follow-up commits. The README pre-release callout now correctly points at the v0.3.0-alpha.* line (addressing the earlier wording note), and the dev merge resolved CHANGELOG.md cleanly — Added entries from dev sit above the PyPI install Changed entry with no duplication. The net diff vs dev is still the same six doc files; CI (lint, test, skills-lint) is green, and uvx --from pipefy-cli pipefy --version still resolves 0.3.0-alpha.1 from PyPI without --prerelease allow.

What worked well

  • Responsive fix for the version narrative in the install callout.
  • Clean CHANGELOG conflict resolution after merging dev.
  • Consistent PyPI install story across README, CLI README, MIGRATION, commands/install.md, and RELEASE.md.
  • Thorough CHANGELOG entry tying the cutover to #234 and #368.

Verification

uvx --from pipefy-cli pipefy --version
uv tool install pipefy-cli

@gbrlcustodio
gbrlcustodio merged commit 2341b61 into dev Jul 7, 2026
3 checks passed
@gbrlcustodio
gbrlcustodio deleted the chore/cli-pypi-install branch July 7, 2026 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Docs, skills, README, or in-repo guides only (no runtime change)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants