Skip to content

Commit cd11984

Browse files
author
Stephen Gutekanst
committed
README: update to reflect search + other recently added commands
1 parent 4f20e43 commit cd11984

1 file changed

Lines changed: 12 additions & 14 deletions

File tree

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Sourcegraph CLI [![Build Status](https://travis-ci.org/sourcegraph/src-cli.svg)](https://travis-ci.org/sourcegraph/src-cli) [![Build status](https://ci.appveyor.com/api/projects/status/fwa1bkd198hyim8a?svg=true)](https://ci.appveyor.com/project/sourcegraph/src-cli) [![Go Report Card](https://goreportcard.com/badge/sourcegraph/src-cli)](https://goreportcard.com/report/sourcegraph/src-cli)
22

3-
The Sourcegraph CLI provides access to [Sourcegraph](https://sourcegraph.com) via a command line interface.
3+
The Sourcegraph `src` CLI provides access to [Sourcegraph](https://sourcegraph.com) via a command line interface.
44

5-
## Status of the project
5+
![image](https://user-images.githubusercontent.com/3173176/43567326-3db5f31c-95e6-11e8-9e74-4c04079c01b0.png)
66

7-
Currently, the `src` CLI only provides access to Sourcegraph's GraphQL API. It lets you:
7+
It currently provides the ability to:
88

9-
- Execute GraphQL queries against a Sourcegraph instance, and get JSON results back.
10-
- Provide your API access token via an environment variable or file on disk.
9+
- **Execute search queries** from the command line and get nice colorized output back (or JSON, optionally).
10+
- **Execute GraphQL queries** against a Sourcegraph instance, and get JSON results back (`src api`).
11+
- You can provide your API access token via an environment variable or file on disk.
12+
- You can easily convert a `src api` command into a curl command with `src api -get-curl`.
13+
- **Manage repositories, users, and organizations** using the `src repos`, `src users`, and `src orgs` commands.
1114

12-
**In the future** it may provide much more:
13-
14-
- Executing search queries from the command line easily and getting formatted results back,
15-
- A command-line management interface for Sourcegraph instances: adding users, deleting users, etc.
15+
If there is something you'd like to see Sourcegraph be able to do from the CLI, let us know! :)
1616

1717
## Installation
1818

@@ -61,8 +61,6 @@ go get -u github.com/sourcegraph/src-cli/cmd/src
6161

6262
## Releasing
6363

64-
1. Find the latest version (either via the releases tab on GitHub or via git tags) to determine which version you are releasing.
65-
2. `VERSION=9.9.9 ./release.sh` (replace `9.9.9` with the version you are releasing)
66-
3. Travis will automatically perform the release. Once it has finished, **confirm that the curl commands fetch the latest version above**.
67-
68-
64+
1. Find the latest version (either via the releases tab on GitHub or via git tags) to determine which version you are releasing.
65+
2. `VERSION=9.9.9 ./release.sh` (replace `9.9.9` with the version you are releasing)
66+
3. Travis will automatically perform the release. Once it has finished, **confirm that the curl commands fetch the latest version above**.

0 commit comments

Comments
 (0)