• Stars
    star
    261
  • Rank 156,630 (Top 4 %)
  • Language
    Go
  • License
    Apache License 2.0
  • Created over 6 years ago
  • Updated 9 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Sourcegraph CLI

Sourcegraph CLI Build Status Go Report Card

src is a command line interface to Sourcegraph:

  • Search & get results in your terminal
  • Search & get JSON for programmatic consumption
  • Make GraphQL API requests with auth easily & get JSON back fast
  • Execute batch changes
  • Manage & administrate repositories, users, and more
  • Easily convert src-CLI commands to equivalent curl commands, just add --get-curl!

Note: Using Sourcegraph 3.12 or earlier? See the older README.

Installation

Binary downloads are available on the releases tab, and through Sourcegraph.com. If the latest version does not work for you, consider using the version compatible with your Sourcegraph instance instead.

Installation: Mac OS

Latest version

curl -L https://sourcegraph.com/.api/src-cli/src_darwin_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src

or with Homebrew:

brew install sourcegraph/src-cli/src-cli

or with npm:

npm install -g @sourcegraph/src

Version compatible with your Sourcegraph instance

Replace sourcegraph.example.com with your Sourcegraph instance URL:

curl -L https://sourcegraph.example.com/.api/src-cli/src_darwin_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src

or, if you know the specific version to target, for example 3.43.2:

brew install sourcegraph/src-cli/[email protected]

or with npm/npx:

npx @sourcegraph/[email protected] version

Note: Versioned formulas are available on Homebrew for Sourcegraph versions 3.43.2 and later.

Installation: Linux

Latest version

curl -L https://sourcegraph.com/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src

or with npm:

npm install -g @sourcegraph/src

Version compatible with your Sourcegraph instance

Replace sourcegraph.example.com with your Sourcegraph instance URL:

curl -L https://sourcegraph.example.com/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src

or, with npm/npx, if you know the specific version to target, for example 3.43.2:

npx @sourcegraph/[email protected] version

Installation: Windows

See Sourcegraph CLI for Windows.

Installation: Docker

sourcegraph/src-cli is published to Docker Hub. You can use the latest tag or a specific version such as 3.43. To see all versions view sourcegraph/src-cli tags.

docker run --rm=true sourcegraph/src-cli:latest search 'hello world'

Log into your Sourcegraph instance

Run src login SOURCEGRAPH-URL to authenticate src to access your Sourcegraph instance with your user credentials.

Examples src login https://sourcegraph.example.com src login https://sourcegraph.com

src consults the following environment variables:

  • SRC_ENDPOINT: the URL to your Sourcegraph instance (such as https://sourcegraph.example.com)
  • SRC_ACCESS_TOKEN: your Sourcegraph access token (on your Sourcegraph instance, click your user menu in the top right, then select Settings > Access tokens to create one)

For convenience, you can add these environment variables persistently.

Configuration: Mac OS / Linux

Add the following to your terminal profile file, typically accessible at ~/.bash_profile (if using Bash) or ~/.zprofile (if using Zsh):

export SRC_ACCESS_TOKEN=my-token
export SRC_ENDPOINT=https://sourcegraph.example.com 

Replace my-token and https://sourcegraph.example.com with the appropriate values for your account and instance.

You can also inline them in a single command with:

SRC_ENDPOINT=https://sourcegraph.example.com SRC_ACCESS_TOKEN=my-token src search 'foo'

Configuration: Windows

Type the following on your PowerShell terminal:

$env.SRC_ENDPOINT = 'https://sourcegraph.example.com'
$env.SRC_ACCESS_TOKEN = 'my-token'

Replace my-token and https://sourcegraph.example.com with the appropriate values for your account and instance.

You can also manually add them via the System Properties windows. Check this post for details.

Is your Sourcegraph instance behind a custom auth proxy? See auth proxy configuration docs.

Usage

src provides different subcommands to interact with different parts of Sourcegraph:

  • src login - authenticate to a Sourcegraph instance with your user credentials
  • src search - perform searches and get results in your terminal or as JSON
  • src api - run Sourcegraph GraphQL API requests
  • src batch - execute and manage batch changes
  • src repos - manage repositories
  • src users - manage users
  • src orgs - manages organization
  • src config - manage global, org, and user settings
  • src extsvc - manage external services (repository configuration)
  • src extensions - manage extensions
  • src code-intel - manages Code Intelligence data (deprecated alias: src lsif)
  • src serve-git - serves your local git repositories over HTTP for Sourcegraph to pull
  • src version - check version and guaranteed-compatible version for your Sourcegraph instance

Run src -h and src <subcommand> -h for more detailed usage information. You can also read the usage docs for the latest version of src-cli online.

Optional: Renaming src

If you have a naming conflict with the src command, such as a Bash alias, you can rename the static binary. For example, on Linux / Mac OS:

mv /usr/local/bin/src /usr/local/bin/src-cli

You can then invoke it via src-cli.

Telemetry

src includes the operating system and architecture in the User-Agent header sent to Sourcegraph. For example, running src version 3.21.10 on an x86-64 Linux host will result in this header:

src-cli/3.21.10 linux amd64

To disable this and only send the version, you can set -user-agent-telemetry=false for a single command, or set the SRC_DISABLE_USER_AGENT_TELEMETRY environment variable to any non-blank string.

As with other Sourcegraph telemetry, any collected data is only sent to Sourcegraph.com in aggregate form.

Development

Some useful notes on developing src can be found in DEVELOPMENT.md.

More Repositories

1

sourcegraph

Code AI platform with Code Search & Cody
Go
9,777
star
2

conc

Better structured concurrency for go
Go
6,764
star
3

checkup

Distributed, lock-free, self-hosted health checks and status pages
Go
3,392
star
4

cody

Type less, code more: Cody is an AI code assistant that uses advanced search and codebase context to help you write and fix code.
TypeScript
2,348
star
5

thyme

Automatically track which applications you use and for how long.
Go
2,237
star
6

appdash

Application tracing system for Go, based on Google's Dapper.
Go
1,720
star
7

webloop

WebLoop: Scriptable, headless WebKit with a Go API. Like PhantomJS, but for Go.
Go
1,357
star
8

go-langserver

Go language server to add Go support to editors and other tools that use the Language Server Protocol (LSP)
Go
1,163
star
9

srclib

srclib is a polyglot code analysis library, built for hackability. It consists of language analysis toolchains (currently for Go and Java, with Python, JavaScript, and Ruby in beta) with a common output format, and a CLI tool for running the analysis.
Go
944
star
10

doctree

First-class library documentation for every language (based on tree-sitter), with symbol search & more. Lightweight single binary, run locally or self-host. Surfaces usage examples via Sourcegraph.
Go
848
star
11

javascript-typescript-langserver

JavaScript and TypeScript code intelligence through the Language Server Protocol
TypeScript
792
star
12

sg.nvim

Experimental Sourcegraph + Cody plugin for Neovim
Lua
707
star
13

go-diff

Unified diff parser and printer for Go
Go
407
star
14

thesrc

Example of a 3-layer (frontend, API, datastore) Go web app (based on the code that powers https://sourcegraph.com)
Go
396
star
15

go-selenium

Selenium WebDriver client for Go
Go
364
star
16

go-webkit2

WebKit API bindings (WebKitGTK+ v2) for Go
Go
305
star
17

syntaxhighlight

Go package for syntax highlighting of code
Go
263
star
18

scip

SCIP Code Intelligence Protocol
Go
257
star
19

zoekt

Fast trigram based code search
Go
229
star
20

prototools

documentation generator & other tools for protobuf/gRPC
Go
162
star
21

jsonrpc2

Package jsonrpc2 provides a client and server implementation of JSON-RPC 2.0 (http://www.jsonrpc.org/specification)
Go
159
star
22

awesome-code-ai

A list of AI coding tools (assistants, completions, refactoring, etc.)
157
star
23

careers

Want to work at Sourcegraph?
132
star
24

openctx

See contextual info about code from your dev tools, in your editor, code review, and anywhere else you read code.
TypeScript
122
star
25

lsif-go

Language Server Indexing Format (LSIF) generator for Go
Go
111
star
26

deploy-sourcegraph

Deploy Sourcegraph to a Kubernetes cluster for large-scale code search and intelligence
Shell
104
star
27

python-langserver

Language server which talks LSP via JSONRPC for Python.
Python
102
star
28

emacs-lsp

LSP support for Emacs
Emacs Lisp
102
star
29

apiproxy

apiproxy proxies HTTP/REST APIs with configurable cache timeouts, etc.
Go
96
star
30

syntect_server

HTTP code syntax highlighting server written in Rust.
Rust
89
star
31

handbook

📘 The Sourcegraph handbook
TypeScript
87
star
32

llmsp

LLM-power language server protocol implementation.
Go
85
star
33

about

Sourcegraph blog, feature announcements, and website (about.sourcegraph.com)
TypeScript
84
star
34

sourcegraph-vscode-DEPRECATED

*️⃣+ 🆚 = ❤️
TypeScript
83
star
35

go-vcs

manipulate and inspect VCS repositories in Go
Go
77
star
36

deploy-sourcegraph-docker

Sourcegraph with Docker Compose deployment reference
Shell
73
star
37

go-lsp

Go types for the messages used in the Language Server Protocol.
Go
71
star
38

scip-java

SCIP Code Intelligence Protocol (LSIF) generator for Java
Java
60
star
39

docsite

The documentation site used by Sourcegraph
Go
57
star
40

codenotify

Go
55
star
41

codeintellify

Adds code intelligence to code views on the web ✨
TypeScript
55
star
42

jetbrains

Kotlin
54
star
43

browser-extensions

Sourcegraph's browser extensions: MOVED. See https://docs.sourcegraph.com/integration/browser_extension.
TypeScript
49
star
44

go-ses

Amazon AWS Simple Email Service (SES) client for Go
Go
49
star
45

emacs-cody

Sourcegraph Cody in Emacs
Emacs Lisp
48
star
46

sourcegraph-extension-api

Sourcegraph extension API: use and build extensions that enhance reading and reviewing code in your existing tools. "The extension API you wish your code host had."
TypeScript
44
star
47

srclib-cpp

43
star
48

go-sourcegraph

Go
43
star
49

scip-typescript

SCIP indexer for TypeScript and JavaScript
TypeScript
43
star
50

go-template-lint

Linter for Go text/template (and html/template) template files
Go
40
star
51

android-sdk-jars

HTML
40
star
52

run

🏃‍♂️ A new way to execute commands and manipulate command output in Go
Go
40
star
53

codesearch.ai

codesearch.ai semantic code search engine
Go
36
star
54

sourcegraph-jetbrains

Sourcegraph for JetBrains IDEs (IntelliJ)
Java
36
star
55

docs

Web app and content for the new Sourcegraph documentation.
TypeScript
35
star
56

lsif-node

Language Server Indexing Format (LSIF) generator for JavaScript and TypeScript
TypeScript
35
star
57

sourcegraph-typescript

Provides code intelligence for TypeScript
TypeScript
34
star
58

lsif-py

Language Server Indexing Format (LSIF) generator for Python
Python
31
star
59

srclib-c

Makefile
30
star
60

srclib-go

Go toolchain for srclib
Go
29
star
61

lsp-adapter

lsp-adapter provides a proxy which adapts Sourcegraph LSP requests to vanilla LSP requests
Go
29
star
62

s3cache

Amazon S3 storage interface for a Go cache
Go
29
star
63

srclib-python

Python
28
star
64

pydep

a simple command line tool / package that prints the dependencies of a python project
Python
28
star
65

app

Issue tracker for the Sourcegraph app - a lightweight single-binary version of Sourcegraph for your local machine
27
star
66

sg

sg releases
27
star
67

helix-docker

Docker images for Perforce Helix
Dockerfile
27
star
68

code-intel-extensions

Provides precise code intelligence via LSIF and Language Servers, and fuzzy code intelligence using ctags and text search
TypeScript
26
star
69

scip-clang

C++
25
star
70

makex

makex is a "make" clone for Go that makes it easier to write build tools in Go. It lets you define tasks and dependencies in the familiar Makefile format, and unlike just shelling out to "make", it gives you programmatic access (in Go) to the progress and console output of your tasks.
Go
24
star
71

scip-python

SCIP indexer for Python
Python
23
star
72

codemod

A collection of codemods powered by TS-Morph and PostCSS
TypeScript
23
star
73

jsonx

Extended JSON parser and writer for Go
Go
21
star
74

srclib-csharp

placeholder for a srclib C# toolchain
C#
20
star
75

learn

Sourcegraph Learn: an educational hub to support all developers
TypeScript
19
star
76

lsif-jsonnet

Language Server Index Format (LSIF) generator for JSonnet
Go
19
star
77

vcsstore

vcsstore stores VCS repositories and makes them accessible via HTTP
Go
19
star
78

sourcegraph-sublime

Sourcegraph for Sublime Text 3
Python
18
star
79

sourcegraph-git-extras

A Sourcegraph extension that adds Git blame and other useful features to code views on Sourcegraph, GitHub, GitLab, etc.
TypeScript
18
star
80

xconf

xconf.io is a config file search engine built on the Sourcegraph (https://sourcegraph.com) API. It currently supports Dockerfiles.
Go
18
star
81

go-jsonschema

EXPERIMENTAL: A Go library for working with JSON Schema (draft-07): parsing schemas, generating Go types from a JSON Schema
Go
17
star
82

themes

Color themes for Sourcegraph and editors
Shell
17
star
83

talks

Talks given about Sourcegraph or by Sourcegraphers
Go
17
star
84

phabricator-extension

Get code intelligence on Phabricator
PHP
16
star
85

httpfstream

httpstream provides HTTP handlers for simultaneous streaming uploads and downloads of objects, as well as persistence and a standalone server.
Go
16
star
86

batch-change-examples

A collection of examples for Batch Changes
Python
16
star
87

sourcegraph-alfred

Sourcegraph workflow for Alfred
Python
15
star
88

gen-mocks

Go
14
star
89

sbt-sourcegraph

sbt plugin to upload LSIF indexes to Sourcegraph for precise code intelligence
Scala
13
star
90

go-vcsurl

Lenient VCS repository URL parsing library for Go
Go
13
star
91

srclib-javascript

JavaScript (node.js) toolchain for srclib
JavaScript
12
star
92

appmon

Appmon tracks API calls in Web applications that use Go.
Go
12
star
93

srclib-php

PHP toolchain for srclib (https://srclib.org) - WORK IN PROGRESS
PHP
12
star
94

yj

Convert YAML to JSON
Go
12
star
95

go-papertrail

Go API client for papertrail (https://papertrailapp.com), a hosted log management service.
Go
12
star
96

log

OpenTelemetry-compatible Zap logger for Sourcegraph
Go
11
star
97

scip-go

SCIP indexer for Golang
Go
11
star
98

annotate

Go package for applying multiple sets of annotations to a region of text
Go
11
star
99

codesearchguide.org

Everything you ever wanted to know about code search. (WIP, will be online soon!)
CSS
11
star
100

multicache

Package multicache provides a "fallback" cache implementation that short-circuits gets and writes/deletes to all underlying caches.
Go
11
star