From 8fc846938c17579284291404561c5dffdc22b9c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20HOUZ=C3=89?= Date: Sat, 19 Sep 2026 13:26:25 +0200 Subject: [PATCH] Remove gh auth token doc content anticipated by #207's PR PR #209 (closing #207, GCS_DEFAULT_ORG) prematurely documented the GITHUB_TOKEN -> gh auth token fallback that belongs to #208 and hadn't been implemented yet at merge time. Revert those specific mentions from README.md, docs/getting-started/index.md, docs/getting-started/first-search.md and docs/reference/environment.md, keeping only the GCS_DEFAULT_ORG content. PR #210 (closing #208) reintroduces this documentation alongside the actual implementation. --- README.md | 1 - docs/getting-started/first-search.md | 2 +- docs/getting-started/index.md | 4 ---- docs/reference/environment.md | 2 -- 4 files changed, 1 insertion(+), 8 deletions(-) diff --git a/README.md b/README.md index 0270c72..1437413 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,6 @@ github-code-search query "TODO" --org my-org ``` > [!TIP] -> `GITHUB_TOKEN` falls back to `gh auth token` when unset and the [GitHub CLI](https://cli.github.com/) is installed and authenticated. > Set `GCS_DEFAULT_ORG=my-org` to omit `--org` on every call. See [Environment variables](https://fulll.github.io/github-code-search/reference/environment). ## Features diff --git a/docs/getting-started/first-search.md b/docs/getting-started/first-search.md index f5032f8..49e35c9 100644 --- a/docs/getting-started/first-search.md +++ b/docs/getting-started/first-search.md @@ -7,7 +7,7 @@ This guide walks through a complete search session from first invocation to stru Make sure you have: - `github-code-search` [installed](/getting-started/installation) -- `GITHUB_TOKEN` set in your environment, or the [GitHub CLI](https://cli.github.com/) installed and authenticated ([see Prerequisites](/getting-started/)) +- `GITHUB_TOKEN` set in your environment ([see Prerequisites](/getting-started/)) ## Run a search diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 48d1168..42be454 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -35,10 +35,6 @@ Add this to your shell profile (`~/.zshrc`, `~/.bashrc`, `~/.config/fish/config. Never commit your token to version control. Use environment variables or a secrets manager. ::: -::: tip Already using the GitHub CLI? -If `GITHUB_TOKEN` isn't set and [`gh`](https://cli.github.com/) is installed and authenticated (`gh auth login`), `github-code-search` automatically retrieves a token via `gh auth token` — no extra setup needed. -::: - ## Default organization If you mostly search a single organization, set `GCS_DEFAULT_ORG` once to omit `--org` on every call: diff --git a/docs/reference/environment.md b/docs/reference/environment.md index ecb12c8..1125d45 100644 --- a/docs/reference/environment.md +++ b/docs/reference/environment.md @@ -25,8 +25,6 @@ Add this to your shell profile (`~/.zshrc`, `~/.bashrc`, `~/.config/fish/config. | `public_repo` | Searching public repositories only | | `read:org` | Using [`--group-by-team-prefix`](/usage/team-grouping) | -If `GITHUB_TOKEN` isn't set and the [GitHub CLI](https://cli.github.com/) (`gh`) is installed and authenticated, `github-code-search` automatically falls back to the token returned by `gh auth token` — no extra configuration needed. - ## `GCS_DEFAULT_ORG` ```bash