Skip to content

Clarify gh CLI shortcut on homepage, bump Bun version requirement to >=1.4 #212

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
shouze merged 1 commit into from
Sep 19, 2026
Merged

Clarify gh CLI shortcut on homepage, bump Bun version requirement to >=1.4 #212

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for taking the time to contribute! This document describes how to set

## Prerequisites

- [Bun](https://bun.sh) ≥ 1.0
- [Bun](https://bun.sh) ≥ 1.4
- A GitHub personal access token with `repo` scope (for integration testing)

## Development setup
Expand Down
21 changes: 21 additions & 0 deletions docs/.vitepress/theme/InstallSection.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,27 @@ function copySearch() {
<h3 class="is-step-label">
<span class="sr-only">Step 2: </span>Export your GitHub token
</h3>
<div class="is-token-hint is-token-hint-skip">
<svg
class="is-info-icon"
width="15"
height="15"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="2"
stroke-linecap="round"
stroke-linejoin="round"
aria-hidden="true"
>
<circle cx="12" cy="12" r="10" />
<path d="M12 16v-4M12 8h.01" />
</svg>
Already using the
<a href="https://cli.github.com/" target="_blank" rel="noopener noreferrer"
>GitHub CLI</a
>? Skip this step — a token is retrieved automatically via <code>gh auth token</code>.
Comment thread
shouze marked this conversation as resolved.
</div>
<div class="is-token-hint">
<svg
class="is-info-icon"
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The only runtime prerequisite is a **GitHub personal access token** (or the [GitHub CLI](https://cli.github.com/), see below). The pre-compiled binary is self-contained and has no runtime dependency — you do not need Bun to run it.

::: tip Building from source?
If you want to build `github-code-search` from source, you will additionally need [Bun](https://bun.sh) ≥ 1.0. See the [Installation guide](/getting-started/installation#from-source).
If you want to build `github-code-search` from source, you will additionally need [Bun](https://bun.sh) ≥ 1.4. See the [Installation guide](/getting-started/installation#from-source).
:::

## GitHub token
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The script automatically adds the install directory to your user PATH. New termi

## From source

Requires [Bun](https://bun.sh) ≥ 1.0.
Requires [Bun](https://bun.sh) ≥ 1.4.

```bash
git clone https://github.com/fulll/github-code-search
Expand Down
Loading