Skip to content

Commit 40a7188

Browse files
author
Noah Lee
authored
Add the document for CLI (#32)
* Add the document for CLI * Update the path with `latest`
1 parent 5cd0b8d commit 40a7188

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

docs/tasks/cli.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# CLI
6+
7+
## Installation
8+
9+
Gitploy provides a command tool for each version. The most recent version of the command is provided on this page, but if you need a specific version of the command, you can check the assets by version on the [release](https://github.com/gitploy-io/gitploy/releases) page of GitHub.
10+
11+
### Binary Downloads
12+
13+
Download and install the raw binaries by platform:
14+
15+
|platform | download | verify
16+
|--- |--- |---
17+
|Linux x64 |[tarball](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_linux_amd64.tar.gz) |[checksum](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_checksums.txt)
18+
|Linux arm64 |[tarball](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_linux_arm64.tar.gz) |[checksum](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_checksums.txt)
19+
|Linux arm |[tarball](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_linux_arm.tar.gz) |[checksum](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_checksums.txt)
20+
|Windows x64 |[tarball](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_windows_amd64.tar.gz) |[checksum](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_checksums.txt)
21+
|Darwin x64 |[tarball](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_darwin_amd64.tar.gz) |[checksum](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_checksums.txt)
22+
|Darwin arm64 |[tarball](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_darwin_arm64.tar.gz) |[checksum](https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_checksums.txt)
23+
24+
### Install on Linux
25+
26+
Download and install on Linux:
27+
28+
```shell
29+
curl -L https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_linux_amd64.tar.gz | tar zx
30+
sudo install -t /usr/local/bin gitploy
31+
```
32+
33+
### Install on OSX
34+
35+
Download and install on OSX:
36+
37+
```shell
38+
curl -L https://github.com/gitploy-io/gitploy/releases/latest/download/gitploy_darwin_amd64.tar.gz | tar zx
39+
sudo cp gitploy /usr/local/bin
40+
```
41+
42+
## Configuration
43+
44+
The command-line tools interact with the server using REST endpoints. You will need to provide the CLI tools with the server addresses and your authorization token. You can find your authorization token in your Gitploy account settings (click your Avatar in the user interface).
45+
46+
**1\. Configure your Gitploy server address:**
47+
48+
```shell
49+
export GITPLOY_SERVER_HOST=https://cloud.gitploy.io/
50+
```
51+
52+
*⚠️The host must have a trailing slash (i.e., '/').*
53+
54+
**2\. Configure your Gitploy token:**
55+
56+
```shell
57+
export GITPLOY_TOKEN=vrdxGkiokoSyhoRStgryF....
58+
```

0 commit comments

Comments
 (0)