Skip to content

Remove gh auth token doc content anticipated by #207's PR #211

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
+1 −8
Merged

Remove gh auth token doc content anticipated by #207's PR #211

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
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/first-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 0 additions & 4 deletions docs/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading