From d8156ba43e4e7066b602839e8aa50b8c3a7c4e78 Mon Sep 17 00:00:00 2001 From: Alex Cunha Date: Fri, 23 Oct 2026 08:24:33 -0700 Subject: [PATCH 1/2] Document upgrading and installing with pipx, and test the pipx install in CI Co-Authored-By: Claude Opus 5.5 --- .github/workflows/cross-platform-ci.yml | 27 +++++++++++++++++++++++++ README.md | 20 ++++++++++++++++++ 2 files changed, 47 insertions(+) diff --git a/.github/workflows/cross-platform-ci.yml b/.github/workflows/cross-platform-ci.yml index b1cc8f7..d97b4c9 100644 --- a/.github/workflows/cross-platform-ci.yml +++ b/.github/workflows/cross-platform-ci.yml @@ -107,6 +107,33 @@ jobs: cp -r tests pyproject.toml "$RUNNER_TEMP/" cd "$RUNNER_TEMP" && uvx --with "$GITHUB_WORKSPACE" pytest + pipx-install: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-24.04, macos-latest, macos-15-intel, windows-latest] + + steps: + - uses: actions/checkout@v4 + + - name: Install with pipx + run: | + pipx install . + pipx environment --value PIPX_BIN_DIR >> "$GITHUB_PATH" + + - name: Test CLI help + run: modcli --help + + - name: Test auth commands + run: modcli auth --help + + - name: Test bundle commands + run: modcli bundle --help + + - name: Test config commands + run: modcli config --help + # The oldest versions pyproject.toml allows (click>=8.0) on the oldest Python lowest-deps: runs-on: ubuntu-24.04 diff --git a/README.md b/README.md index 6357547..9fc5e20 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,30 @@ Using pip: pip install --upgrade pip pip install git+https://github.com/mod-audio/mod-devel-cli +Using pipx: + + pipx install git+https://github.com/mod-audio/mod-devel-cli + Using uv: uv tool install git+https://github.com/mod-audio/mod-devel-cli +## Upgrading + +Using pip: + + pip install --upgrade git+https://github.com/mod-audio/mod-devel-cli + +Using pipx: + + pipx upgrade mod-devel-cli + +Using uv: + + uv tool upgrade mod-devel-cli + +Upgrading keeps the environments saved in `~/.config/modcli`. To get a new version's default environments, run `modcli config clear-context` (this also removes the stored tokens), or add a single one with `modcli config add-env`. + ## Usage ``` From 6f94c3dfdbfc1ac1fe34bb69a8f2c7cd2efa2018 Mon Sep 17 00:00:00 2001 From: Alex Cunha Date: Thu, 12 Nov 2026 22:31:02 -0800 Subject: [PATCH 2/2] Stop recommending clear-context for upgrades, as it removes the stored tokens Co-Authored-By: Claude Opus 5.5 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fc5e20..99706d1 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Using uv: uv tool upgrade mod-devel-cli -Upgrading keeps the environments saved in `~/.config/modcli`. To get a new version's default environments, run `modcli config clear-context` (this also removes the stored tokens), or add a single one with `modcli config add-env`. +Upgrading keeps the environments saved in `~/.config/modcli`. To get a new version's default environment, add it with `modcli config add-env`. ## Usage