Skip to content

docs: add installation instructions for Homebrew, WinGet, and Scoop#959

Merged
saghul merged 1 commit into
saghul:masterfrom
bangseongbeom:installation-instructions
Jun 15, 2026
Merged

docs: add installation instructions for Homebrew, WinGet, and Scoop#959
saghul merged 1 commit into
saghul:masterfrom
bangseongbeom:installation-instructions

Conversation

@bangseongbeom

Copy link
Copy Markdown
Contributor

Related to #915. Not closing it yet since there is still an ongoing discussion around mise.

This PR adds installation instructions for Homebrew, WinGet, and Scoop.

For Homebrew, this uses a custom tap, bangseongbeom/tap, instead of the official homebrew-core, because the formula depends on too many custom parts to be a good fit for the offical homebrew-core. See Homebrew/homebrew-core#272588 (comment) for context.

From the perspective of someone installing the package, I think saghul/tap, maintained by saghul as the owner of this repository, would be more trustworthy than installing from my personal tap. Please let me know if you would like to discuss taking over or maintaining the custom tap.

Copilot AI review requested due to automatic review settings June 4, 2026 16:10

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the Getting Started documentation to include package-manager installation options across macOS, Linux, and Windows.

Changes:

  • Added Homebrew installation instructions for macOS and Linux.
  • Added WinGet and Scoop installation instructions for Windows.
  • Reorganized the installation section by separating “Prebuilt binaries” and “Build from source”.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread website/docs/getting-started.md
Comment thread website/docs/getting-started.md
### [WinGet](https://learn.microsoft.com/windows/package-manager/) (Windows)

```powershell
winget install Saghul.TxikiJS

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Does this work? Have you published it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, it works. I published it.

You can find it in winget-pkgs here: https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Saghul/TxikiJS

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Awesome! ❤️

### [Scoop](https://scoop.sh/) (Windows)

```powershell
scoop install txikijs

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Same question :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I tested it, and it works well.

burdockcascade published it through ScoopInstaller/Main#7794.

Comment thread website/docs/getting-started.md Outdated
### [Homebrew](https://brew.sh/) (macOS and Linux)

```bash
brew install bangseongbeom/tap/txikijs

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks for putting this together! Do you mind if I create such a repo copying yours?

@bangseongbeom bangseongbeom Jun 5, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Absolutely! Feel free to copy it into your own repository. If you have any questions or need anything while moving it over, just let me know.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thank you so much!

@lukasMega

Copy link
Copy Markdown

for mise ( https://mise.jdx.dev ) should I create separate PR with instructions?

@saghul

saghul commented Jun 5, 2026

Copy link
Copy Markdown
Owner

for mise ( https://mise.jdx.dev ) should I create separate PR with instructions?

Yeah, we can add it right after this one lands.

@saghul saghul force-pushed the installation-instructions branch from ebe28c0 to 6f0fa86 Compare June 15, 2026 09:34
@saghul saghul merged commit de1e700 into saghul:master Jun 15, 2026
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.

4 participants