Skip to content

Mention uvx quickstart and playground in README and getting started #127

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
thejchap merged 2 commits into from
May 19, 2026
Merged

Mention uvx quickstart and playground in README and getting started #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5da15fd
docs: mention uvx quickstart and playground in README and getting-sta…
claude May 19, 2026
273ddf1
tweaks
thejchap May 19, 2026
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
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,36 @@ out of sync with the Rust code.
`cargo insta accept`
3. commit the `.snap` files alongside code changes

## playground

the browser playground lives in `playground/`. to run it locally:
Comment on lines +65 to +67
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot May 19, 2026

Choose a reason for hiding this comment

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

P2 Badge Remove playground setup until the files exist

For contributors on this revision, these new instructions cannot be followed because the repository does not contain a playground/ directory, and .github/workflows also has no playground workflow for the later auto-deploy claim. I checked repo-wide for playground/wasm paths and the GitHub workflows, so this section appears to document assets from the split-out playground work before they have landed.

Useful? React with 👍 / 👎.


```bash
cd playground
bun install
bun run dev
```

to deploy manually to Cloudflare Pages:

```bash
cd playground
bun run build
bunx wrangler pages deploy dist --project-name=tryke-playground
```

this creates a preview deployment at a unique URL (e.g.
`<hash>.tryke-playground.pages.dev`). to deploy straight to production, add
Comment on lines +83 to +84
Comment on lines +83 to +84
`--branch main` — this is just metadata passed to Cloudflare and works from
any local branch:

```bash
bunx wrangler pages deploy dist --project-name=tryke-playground --branch main
```

pushes to `main` that touch the playground or WASM crates deploy automatically
to production via the `playground` GitHub Actions workflow.
Comment on lines +92 to +93

## manual release

1. bump version in both `crates/tryke/Cargo.toml` and `pyproject.toml`
Expand Down
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,15 @@

## Getting started

For more information, see the [documentation](https://tryke.dev/).
Run tryke with [uvx](https://docs.astral.sh/uv/guides/tools/) to get started quickly:

Write a test.
```bash
uvx tryke
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot May 19, 2026

Choose a reason for hiding this comment

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

P2 Badge Show the actual one-shot test command

For first-time users copying this README quickstart, uvx tryke does not run the tests once: the CLI treats a bare invocation as the default watch command (Commands::default_watch() sets watch: true and now: false), and the watch option docs say it starts idle until a file change unless --now is passed. This makes the “get started quickly” command appear to hang rather than execute the example; the docs page already uses uvx tryke test, which matches the intended one-shot run.

Useful? React with 👍 / 👎.

```

Or, check out the [tryke playground](https://playground.tryke.dev) to try it out in your browser.

To learn more about using tryke, see the [documentation](https://tryke.dev/).

```python
from typing import Annotated
Expand Down
10 changes: 9 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ A Rust-based Python test runner with a Jest-style API.

## Getting started

Run tryke with [uvx](https://docs.astral.sh/uv/guides/tools/) to get started quickly:

```bash
uvx tryke test
```

Or, check out the [tryke playground](https://playground.tryke.dev) to try it out in your browser.

```python
from typing import Annotated

Expand Down Expand Up @@ -110,4 +118,4 @@ This repository is licensed under the [MIT License](https://github.com/thejchap/

## Installation

See the [installation](guides/installation.md) documentation.
See the [installation](./guides/installation.md) documentation.
Loading