Skip to content

docs: better pipx instructions in README #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
obilodeau merged 1 commit into from
May 27, 2026
Merged

docs: better pipx instructions in README #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,19 @@ Then open http://localhost:5173/.

## Install as a CLI (pipx)

Once published, Ceopardy can be installed as a stand-alone command:
Ceopardy is distributed as a wheel attached to each
[GitHub release](https://github.com/obilodeau/ceopardy/releases). Install the
latest one with pipx (requires `curl` and `jq`):

pipx install "$(curl -fsSL https://api.github.com/repos/obilodeau/ceopardy/releases/latest | jq -r '.assets[] | select(.name | endswith(".whl")) | .browser_download_url')"

Or pick a specific version by pointing pipx at a wheel URL from the
[releases page](https://github.com/obilodeau/ceopardy/releases), e.g.:

pipx install https://github.com/obilodeau/ceopardy/releases/download/v0.6.0/ceopardy-0.6.0-py3-none-any.whl

Then scaffold a game directory and start the server:

pipx install ceopardy
mkdir my-game && cd my-game
ceopardy init # scaffolds data/ and game-media/ in CWD
# edit data/Questions.cp and data/1st.round
Expand Down
Loading