|
1 | 1 | # `dbxcli`: A command line tool for Dropbox users and team admins [UNOFFICIAL] |
2 | 2 |
|
3 | | -[](https://travis-ci.org/dropbox/dbxcli) |
| 3 | +[](https://github.com/dropbox/dbxcli/actions/workflows/ci.yml) |
4 | 4 | [](https://goreportcard.com/report/github.com/dropbox/dbxcli) |
5 | 5 |
|
6 | 6 | :warning: WARNING: This project is **NOT official**. What does this mean? |
@@ -47,21 +47,25 @@ $ chmod +x dbxcli |
47 | 47 | ``` |
48 | 48 |
|
49 | 49 | ### Instructions for building yourself |
50 | | -For newcomers the go build process can be a bit arcane, these steps can be followed to build `dbxcli` yourself. |
51 | 50 |
|
52 | | -1. Make sure `git`, `go`, and `gox` are installed. |
53 | | -2. Create a Go folder. For example, `mkdir $HOME/go` or `mkdir $HOME/.go`. Navigate to it. |
54 | | -3. `go get github.com/dropbox/dbxcli`. That's right, you don't manually clone it, this does it for you. |
55 | | -4. `cd ~/go/src/github.com/dropbox/dbxcli` (adapt accordingly based on step 2). |
| 51 | +1. Make sure `git` and `go` are installed. |
| 52 | +2. Install the latest released version: |
| 53 | + ```sh |
| 54 | + $ go install github.com/dropbox/dbxcli@latest |
| 55 | + ``` |
| 56 | +3. Or build from source: |
| 57 | + ```sh |
| 58 | + $ git clone https://github.com/dropbox/dbxcli.git |
| 59 | + $ cd dbxcli |
| 60 | + $ go build . |
| 61 | + ``` |
| 62 | + |
| 63 | +To use your own Dropbox app while developing, provide its app key when logging in: |
56 | 64 |
|
57 | | -To use your own Dropbox app while developing, provide its app key when running |
58 | | -`dbxcli`: |
59 | 65 | ```sh |
60 | | -$ export DROPBOX_PERSONAL_APP_KEY=your-app-key |
| 66 | +$ dbxcli login --app-key=your-app-key |
61 | 67 | ``` |
62 | 68 |
|
63 | | -Finally we're ready to build. Run `go build`, and you'll see a `dbxcli` binary has been created in the current directory. Congrats, we're done! |
64 | | - |
65 | 69 | ## Usage |
66 | 70 |
|
67 | 71 | `dbxcli` is largely self documenting. Run `dbxcli -h` for a list of supported commands: |
|
0 commit comments