fix: lead with --method oob for headless auth across skills#88
Merged
Conversation
The setup reference documented `--method oob` as preferred for interactive headless shells, but the primary "Authenticate and verify" step led with bare `ggshield auth login` and never pointed at the headless path. Meanwhile the gitguardian-platform.md headless section and several SKILL.md troubleshooting entries told users to reach for `--method token` — two docs, two different answers for the same situation. Reconcile all auth guidance to one doctrine: interactive headless (SSH/container/devcontainer) leads with `--method oob` (ggshield 1.51.0+), `--method token` is the fallback when oob is unsupported, CI uses GITGUARDIAN_API_KEY. - ggshield-cli-setup.md (x4): add a headless pointer in the primary auth step - gitguardian-platform.md (x6): rewrite the headless section to lead with oob - scan-secrets SKILL.md: troubleshooting entry now leads with oob and fixes a stale cross-reference to a non-existent onboarding subsection - scan-machine / create-honeytokens SKILL.md: mention oob first, token fallback Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The auth guidance disagreed with itself on how to log in from a headless environment (SSH session, container, devcontainer):
ggshield-cli-setup.mddocumented--method oobas preferred for interactive headless shells, but parked it in a "Headless and CI" section at the bottom. The primary Authenticate and verify step led with bareggshield auth loginand never cross-referenced the headless path — so unless you read to the end, you'd never learn oob was the preferred option.gitguardian-platform.mdand thescan-secretstroubleshooting entry told users to use--method tokenfor headless, with no mention of oob — the opposite recommendation.scan-secretstroubleshooting entry also pointed at an onboarding subsection ("Headless / non-interactive environments") that no longer exists.Two docs, two different answers for the same situation.
Fix
Reconcile every auth touchpoint to one doctrine:
ggshield-cli-setup.md(×4) — one-line headless pointer in the primary auth stepgitguardian-platform.md(×6) — headless section rewritten to lead with oob, token demoted to fallbackscan-secrets/SKILL.md— troubleshooting entry leads with oob; stale cross-reference fixed to point at the setup reference's "Headless and CI"scan-machine/SKILL.md,create-honeytokens/SKILL.md— mention oob first, token fallbackDuplicated references re-verified byte-identical after the edits; sanity tests pass (11/11).
🤖 Generated with Claude Code