Skip to content

Commit d486f73

Browse files
author
Igor Olshevsky
committed
Merge branch 'master' of github.com:CDEBase/cli-tool
2 parents d1f136e + 3dd4e4d commit d486f73

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

Diff for: README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Cdecode CLI [![Build Status](https://travis-ci.org/cdecode/src-cli.svg)](https://travis-ci.org/cdecode/src-cli) [![Build status](https://ci.appveyor.com/api/projects/status/fwa1bkd198hyim8a?svg=true)](https://ci.appveyor.com/project/cdecode/src-cli) [![Go Report Card](https://goreportcard.com/badge/cdecode/src-cli)](https://goreportcard.com/report/cdecode/src-cli)
1+
# Cdecode CLI [![Build Status](https://travis-ci.org/cdecode/cli-tool.svg)](https://travis-ci.org/cdecode/cli-tool) [![Build status](https://ci.appveyor.com/api/projects/status/fwa1bkd198hyim8a?svg=true)](https://ci.appveyor.com/project/cdecode/cli-tool) [![Go Report Card](https://goreportcard.com/badge/cdecode/cli-tool)](https://goreportcard.com/report/cdecode/cli-tool)
22

3-
The Cdecode `cli` CLI provides access to [Cdecode](https://cdecode.com) via a command-line interface.
3+
The Cdecode `cdecli` CLI provides access to [Cdecode](https://cdecode.com) via a command-line interface.
44

55
![image](https://user-images.githubusercontent.com/3173176/43567326-3db5f31c-95e6-11e8-9e74-4c04079c01b0.png)
66

77
It currently provides the ability to:
88

99
- **Execute search queries** from the command line and get nice colorized output back (or JSON, optionally).
10-
- **Execute GraphQL queries** against a Cdecode instance, and get JSON results back (`src api`).
10+
- **Execute GraphQL queries** against a Cdecode instance, and get JSON results back (`cdecli api`).
1111
- 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.
12+
- You can easily convert a `cdecli api` command into a curl command with `cdecli api -get-curl`.
13+
- **Manage repositories, users, and organizations** using the `cdecli repos`, `cdecli users`, and `cdecli orgs` commands.
1414

1515
If there is something you'd like to see Cdecode be able to do from the CLI, let us know! :)
1616

@@ -19,15 +19,15 @@ If there is something you'd like to see Cdecode be able to do from the CLI, let
1919
### Mac OS:
2020

2121
```bash
22-
curl -L https://github.com/cdecode/cli-tool/releases/download/latest/src_darwin_amd64 -o /usr/local/bin/src
23-
chmod +x /usr/local/bin/src
22+
curl -L https://github.com/CDEBase/cli-tool/releases/download/latest/cli_darwin_amd64 -o /usr/local/bin/cdecli
23+
chmod +x /usr/local/bin/cdecli
2424
```
2525

2626
### Linux:
2727

2828
```bash
29-
curl -L https://github.com/cdecode/cli-tool/releases/download/latest/src_linux_amd64 -o /usr/local/bin/src
30-
chmod +x /usr/local/bin/src
29+
curl -L https://github.com/CDEBase/cli-tool/releases/download/latest/cli_linux_amd64 -o /usr/local/bin/cdecli
30+
chmod +x /usr/local/bin/cdecli
3131
```
3232

3333
### Windows:
@@ -38,36 +38,36 @@ Run in PowerShell as administrator:
3838

3939
```powershell
4040
New-Item -ItemType Directory 'C:\Program Files\Cdecode'
41-
Invoke-WebRequest https://github.com/cdecode/cli-tool/releases/download/latest/src_windows_amd64.exe -OutFile 'C:\Program Files\Cdecode\src.exe'
41+
Invoke-WebRequest https://github.com/CDEBase/cli-tool/releases/download/latest/cli_windows_amd64.exe -OutFile 'C:\Program Files\Cdecode\cdecli.exe'
4242
[Environment]::SetEnvironmentVariable('Path', [Environment]::GetEnvironmentVariable('Path', [EnvironmentVariableTarget]::Machine) + ';C:\Program Files\Cdecode', [EnvironmentVariableTarget]::Machine)
4343
$env:Path += ';C:\Program Files\Cdecode'
4444
```
4545

4646
Or manually:
4747

48-
- [Download the latest src_windows_amd64.exe](https://github.com/cdecode/cli-tool/releases/download/latest/src_windows_amd64.exe) and rename to `src.exe`.
49-
- Place the file under e.g. `C:\Program Files\Cdecode\src.exe`
48+
- [Download the latest cli_windows_amd64.exe](https://github.com/cdecode/cli-tool/releases/download/latest/cli_windows_amd64.exe) and rename to `cdecli.exe`.
49+
- Place the file under e.g. `C:\Program Files\Cdecode\cdecli.exe`
5050
- Add that directory to your system path to access it from any command prompt
5151

5252
## Usage
5353

54-
Consult `src -h` and `src api -h` for usage information.
54+
Consult `cdecli -h` and `cdecli api -h` for usage information.
5555

5656
## Authentication
5757

5858
Some Cdecode instances will be configured to require authentication. You can do so via the environment:
5959

6060
```sh
61-
SRC_ACCESS_TOKEN="secret" src ...
61+
CLI_ACCESS_TOKEN="secret" cdecli ...
6262
```
6363

64-
Or via the configuration file (`~/src-config.json`):
64+
Or via the configuration file (`~/cdecli-config.json` or `<package_root_dir>/config.json`):
6565

6666
```sh
6767
{"accessToken": "secret"}
6868
```
6969

70-
See `src -h` for more information on specifying access tokens.
70+
See `cdecli -h` for more information on specifying access tokens.
7171

7272
To acquire the access token, visit your Cdecode instance (or https://cdecode.com), click your profile picture, and select **access tokens** in the left hand menu.
7373

@@ -76,7 +76,7 @@ To acquire the access token, visit your Cdecode instance (or https://cdecode.com
7676
If you want to develop the CLI, you can install it with `go get`:
7777

7878
```
79-
go get -u github.com/cdecode/src-cli/cmd/src
79+
go get -u github.com/cdecode/cli-tool/cmd/cdecli
8080
```
8181

8282
## Releasing

0 commit comments

Comments
 (0)