|
1 | 1 | # Sourcegraph CLI [](https://travis-ci.org/sourcegraph/src-cli) [](https://ci.appveyor.com/project/sourcegraph/src-cli) [](https://goreportcard.com/report/sourcegraph/src-cli) |
2 | 2 |
|
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. |
4 | 4 |
|
5 | | -## Status of the project |
| 5 | + |
6 | 6 |
|
7 | | -Currently, the `src` CLI only provides access to Sourcegraph's GraphQL API. It lets you: |
| 7 | +It currently provides the ability to: |
8 | 8 |
|
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. |
11 | 14 |
|
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! :) |
16 | 16 |
|
17 | 17 | ## Installation |
18 | 18 |
|
@@ -61,8 +61,6 @@ go get -u github.com/sourcegraph/src-cli/cmd/src |
61 | 61 |
|
62 | 62 | ## Releasing |
63 | 63 |
|
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