Skip to content

docs(readme): document gjsify dlx + gjsify install -g install paths#411

Merged
JumpLink merged 2 commits into
mainfrom
docs/readme-gjsify-install-methods
May 22, 2026
Merged

docs(readme): document gjsify dlx + gjsify install -g install paths#411
JumpLink merged 2 commits into
mainfrom
docs/readme-gjsify-install-methods

Conversation

@JumpLink
Copy link
Copy Markdown
Collaborator

Adds two new install paths

Both Node-free, GJS-runtime only:

One-shot via `gjsify dlx` (npx-style)

```bash
gjsify dlx @ts-for-gir/cli list
gjsify dlx @ts-for-gir/cli generate Gtk-4.0
```

Content-addressed cache at `~/.cache/gjsify/dlx`; subsequent invocations of the same spec reuse it. `--reinstall` forces a refresh.

Global install via `gjsify install -g`

```bash
gjsify install -g @ts-for-gir/cli
ts-for-gir --help
```

Installs into `/.local/share/gjsify/global` and symlinks the binary to `/.local/bin/ts-for-gir`. Re-run to update.

Dependency

Both paths require gjsify v0.4.21+ (the bare-spec → latest dist-tag fix in gjsify/gjsify#249). Without that fix, bare-name resolution picks the abandoned v3.3.0 release instead of 4.0.0-rc.17 because semver `*` skips prereleases.

What's preserved

  • Existing `curl | gjs install.js` one-liner stays as a self-bootstrap path for users who don't have the gjsify CLI installed yet.
  • Node.js `npx` / `npm install -g` section unchanged.

JumpLink added 2 commits May 22, 2026 10:56
Adds two new install methods to the GJS-runtime section of README:

- `gjsify dlx @ts-for-gir/cli [args…]` — npx-style one-shot run.
  Content-addressed cache at `~/.cache/gjsify/dlx`; reuses across
  invocations of the same spec, `--reinstall` forces refresh.
- `gjsify install -g @ts-for-gir/cli` — global install with
  symlinked launcher at `~/.local/bin/ts-for-gir`.

Both paths require only GJS — no Node.js, no npm CLI. They depend on
gjsify v0.4.21+ (the bare-spec → `latest` dist-tag fix in
gjsify/gjsify#249; without that fix, dlx/install -g silently picked
the abandoned v3.3.0 release instead of 4.0.0-rc.17).

The existing `curl | gjs install.js` one-liner is kept as a
self-bootstrap path for users who don't yet have the gjsify CLI
installed.
@JumpLink JumpLink force-pushed the docs/readme-gjsify-install-methods branch from 885f7f8 to 7b7c386 Compare May 22, 2026 08:56
@JumpLink JumpLink merged commit 0a3b6dd into main May 22, 2026
4 checks passed
@JumpLink JumpLink deleted the docs/readme-gjsify-install-methods branch May 22, 2026 08:59
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.

1 participant