Install¶
yt-text currently supports seven practical install paths:
- public Pages download mirror
- curl-to-shell installer
- Homebrew formula
- npm wrapper package
cargo install --gitcargo install --path .nix run
For most users, the public Pages mirror is the cleanest default.
Canonical public download base:
The GitHub release page remains the canonical release record:
curl-to-shell installer¶
curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/install.sh | sh
The installer:
- auto-detects the supported target for the current machine
- downloads the matching mirrored tarball from the Pages mirror
- verifies the tarball against the published
SHA256SUMS - installs
yt-textinto~/.local/binby default
If you override --repo to point at a private GitHub repository, the installer
can still use GH_TOKEN, GITHUB_TOKEN, or gh auth token.
Useful flags:
curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/install.sh | sh -s -- --version v0.1.8
curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/install.sh | sh -s -- --bin-dir "$HOME/bin"
Run curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/install.sh | sh -s -- --help
to see the full option surface.
Homebrew¶
Install from the release-published formula asset:
brew install --formula https://transscendsurvival.org/yt-text/downloads/latest/yt-text.rb
The Homebrew formula installs the published binary release rather than building from source.
npm wrapper package¶
The repository now includes a publishable npm wrapper package at
packages/npm/yt-text.
That package:
- detects the current supported platform
- downloads the matching
yt-textrelease artifact - verifies it against the published
SHA256SUMS - caches the binary locally and then executes it
The wrapper is published to the npm registry as @tummycrypt/yt-text under
the beta dist-tag while the v0.1.x series stabilizes. The latest dist-tag
is reserved for v1.0.
npm install -g @tummycrypt/yt-text@beta
npx -p @tummycrypt/yt-text@beta yt-text -- --version
A GitHub Packages mirror publishes the same build as @jesssullivan/yt-text
for redundancy:
npm install -g --registry=https://npm.pkg.github.com @jesssullivan/yt-text@beta
Tagged releases also attach the packaged .tgz asset as a direct-download
fallback for environments without npm registry access:
npm install -g https://transscendsurvival.org/yt-text/downloads/latest/yt-text-npm-package.tgz
npm exec --yes --package=https://transscendsurvival.org/yt-text/downloads/latest/yt-text-npm-package.tgz yt-text -- --version
Release tarballs¶
Latest published binaries are mirrored publicly at:
Published targets:
aarch64-apple-darwinx86_64-unknown-linux-muslaarch64-unknown-linux-musl
Each release also includes a SHA256SUMS file for checksum verification.
Apple Silicon macOS:
mkdir -p ~/.local/bin && tmpdir="$(mktemp -d)" && curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/yt-text-aarch64-apple-darwin.tar.gz | tar -xz -C "$tmpdir" && install -m 0755 "$tmpdir/yt-text" ~/.local/bin/yt-text
Linux x86_64:
mkdir -p ~/.local/bin && tmpdir="$(mktemp -d)" && curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/yt-text-x86_64-unknown-linux-musl.tar.gz | tar -xz -C "$tmpdir" && install -m 0755 "$tmpdir/yt-text" ~/.local/bin/yt-text
Linux ARM64:
mkdir -p ~/.local/bin && tmpdir="$(mktemp -d)" && curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/yt-text-aarch64-unknown-linux-musl.tar.gz | tar -xz -C "$tmpdir" && install -m 0755 "$tmpdir/yt-text" ~/.local/bin/yt-text
Verify:
yt-text --version
The published tarballs are the official prebuilt distribution channel today.
Verify a Linux tarball against the published checksums:
curl -fsSLO https://transscendsurvival.org/yt-text/downloads/latest/SHA256SUMS
curl -fsSLO https://transscendsurvival.org/yt-text/downloads/latest/yt-text-x86_64-unknown-linux-musl.tar.gz
grep 'yt-text-x86_64-unknown-linux-musl.tar.gz$' SHA256SUMS | sha256sum -c -
On macOS, use shasum -a 256 yt-text-aarch64-apple-darwin.tar.gz and compare the
result with the matching line in SHA256SUMS.
Source installs¶
Git:
cargo install --locked --git https://github.com/Jesssullivan/yt-text yt-text
Local checkout:
cargo install --path .
Nix:
nix run github:jesssullivan/yt-text
nix profile install github:jesssullivan/yt-text
For flake consumers, the repository also exposes overlays.default so you can
add yt-text to a larger Nix configuration without shelling out to nix run.
Requires Rust 1.88+ for source builds.
Platform support¶
The current release workflow publishes and validates these targets on CI:
| Platform | Release asset | CI release build | Recommended install path |
|---|---|---|---|
| Apple Silicon macOS | yt-text-aarch64-apple-darwin.tar.gz |
yes | release tarball |
| Linux x86_64 | yt-text-x86_64-unknown-linux-musl.tar.gz |
yes | release tarball |
| Linux ARM64 | yt-text-aarch64-unknown-linux-musl.tar.gz |
yes | release tarball |
Current support expectations:
- the three published release assets above are the official prebuilt targets
- the installer script selects one of those same published tarballs
- the Homebrew formula installs one of those same published tarballs
- the npm wrapper is designed to bootstrap one of those same published tarballs
cargo install --gitandcargo install --path .are the fallback paths when you are outside those published targets- Nix is supported as a repo-native execution path
- there is no official Windows release artifact today
- there is no official Intel macOS release artifact today
If you are outside the published targets, treat source builds as best-effort/local-validation paths rather than guaranteed prebuilt distributions.
Upgrade¶
Upgrade a release-tarball install¶
Re-run the same install command you used originally. The new binary will
replace the existing one in ~/.local/bin/yt-text.
Upgrade a curl-to-shell install¶
Re-run the same installer command you used originally:
curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/install.sh | sh
Upgrade a Homebrew install¶
brew update
brew upgrade yt-text
Upgrade an npm-wrapper install¶
Re-run the same install command you used originally:
npm install -g https://transscendsurvival.org/yt-text/downloads/latest/yt-text-npm-package.tgz
Apple Silicon macOS:
mkdir -p ~/.local/bin && tmpdir="$(mktemp -d)" && curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/yt-text-aarch64-apple-darwin.tar.gz | tar -xz -C "$tmpdir" && install -m 0755 "$tmpdir/yt-text" ~/.local/bin/yt-text
Linux x86_64:
mkdir -p ~/.local/bin && tmpdir="$(mktemp -d)" && curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/yt-text-x86_64-unknown-linux-musl.tar.gz | tar -xz -C "$tmpdir" && install -m 0755 "$tmpdir/yt-text" ~/.local/bin/yt-text
Linux ARM64:
mkdir -p ~/.local/bin && tmpdir="$(mktemp -d)" && curl -fsSL https://transscendsurvival.org/yt-text/downloads/latest/yt-text-aarch64-unknown-linux-musl.tar.gz | tar -xz -C "$tmpdir" && install -m 0755 "$tmpdir/yt-text" ~/.local/bin/yt-text
Upgrade a Git-based cargo install¶
cargo install --locked --git https://github.com/Jesssullivan/yt-text yt-text --force
Upgrade a local-checkout cargo install¶
From the repo checkout you want to install:
cargo install --path . --force
Upgrade a Nix run workflow¶
nix run github:jesssullivan/yt-text already resolves the requested Git ref at
execution time. If you pin a tag or commit, update that ref when you want a new
version.
Uninstall¶
Uninstall a release-tarball install¶
rm -f ~/.local/bin/yt-text
Uninstall a curl-to-shell install¶
rm -f ~/.local/bin/yt-text
Uninstall a Homebrew install¶
brew uninstall yt-text
Uninstall an npm-wrapper install¶
npm uninstall -g @tummycrypt/yt-text
Uninstall a cargo install¶
cargo uninstall yt-text
Uninstall a Nix run workflow¶
nix run github:jesssullivan/yt-text does not create a long-lived installed
binary on its own, so there is nothing to uninstall unless you separately added
it to a Nix profile.
Packaging posture¶
Official channels today:
- public Pages mirror for the latest release assets
scripts/install.sh- release-published Homebrew formula
yt-text.rb - release-published npm wrapper package
yt-text-npm-package.tgz - source install from Git
- local checkout install
nix run github:jesssullivan/yt-textnix profile install github:jesssullivan/yt-text
Not published today:
- crates.io
- npm registry
- nixpkgs
That means the recommended public install story today is:
- use the installer script if your platform matches a published target
- use the Homebrew formula if you want Brew-managed upgrades
- use
cargo install --gitor Nix if you need a source-backed path