Repository navigation
Add a migration guide for the rebuilt src CLI - #2164
Open
BolajiOlajide wants to merge 1 commit into
Open
BolajiOlajide wants to merge 1 commit into
BolajiOlajide wants to merge 1 commit into
Conversation
Covers the setup, flag, and scripting changes between the legacy src CLI and the rebuilt one, removed and renamed commands, and the changes to each command. Linked from the CLI sidebar and landing page.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Contributor
This branch was successfully deployed
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
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.
The
srcCLI is being rebuilt on Cobra in sourcegraph/sourcegraph (cmd/src), and users moving from the legacysourcegraph/src-clibinary need to know what breaks. This adds/cli/migration, linked from the CLI sidebar and landing page. It covers the setup changes (SRC_ENDPOINTis now required, no config file,src auth login, TLS and proxy changes), flag syntax, moving scripts from-ftemplates to--output jsonand the new exit codes, removed and renamed commands, and the changes to each command.The content comes from
cmd/src/STATE_OF_THE_CLI.md, which tracks every difference from the legacy CLI. Key behaviors were checked against a build ofcmd/srcfrom main.Merge timing: the rebuilt CLI is not publicly released yet, so hold this until it ships. Before merging:
cli/explanations/env.mdxand the quickstart still describe legacy behavior (SRC_ENDPOINTdefaulting to sourcegraph.com,SRC_HEADER_*,src login,src auth token).src auth token,SRC_HEADERS, andSRC_PROXYas unavailable; update it if any of them land first.