Skip to content

Commit ac9a561

Browse files
committed
DOCS: Add README.md
1 parent dc2ea23 commit ac9a561

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# arcusctl
2+
3+
`arcusctl`[ARCUS](https://github.com/naver/arcus)의 운영을 위해 필요한 기능을 제공하는 CLI 도구입니다.
4+
5+
## Getting started
6+
7+
### Install
8+
9+
아래와 같은 방법으로 arcusctl 설치할 수 있습니다.
10+
11+
- [Release Page](https://github.com/jam2in/arcusctl/releases)에서 맞는 pre-built binary 다운로드할 수 있습니다.
12+
```sh
13+
curl -LO https://github.com/jam2in/arcusctl/releases/download/v<VERSION>/arcusctl-<VERSION>.<OS>-<ARCH>.tar.gz
14+
tar zxvf arcusctl-<VERSION>.<OS>-<ARCH>.tar.gz
15+
cd arcusctl-<VERSION>.<OS>-<ARCH>
16+
./arcusctl version
17+
```
18+
19+
- Go toolchain이 설치된 환경에서는 `go install` 활용할 수 있습니다.
20+
```sh
21+
go install github.com/jam2in/arcusctl@latest
22+
arcusctl version
23+
```
24+
25+
- 또는 docker image 활용하여 실행 가능합니다.
26+
```sh
27+
docker run --rm jam2in/arcusctl:latest version
28+
```
29+
30+
### Usage
31+
32+
- help 옵션으로 arcusctl에서 사용 가능한 명령과 사용 방법을 확인할 수 있습니다.
33+
```sh
34+
./arcusctl -h
35+
```
36+
37+
- 아래와 같이 completion 적용할 수 있습니다.
38+
```sh
39+
source <(./arcusctl completion bash)
40+
```
41+
42+
- 그 외 각 명령에 대한 가이드는 [문서](docs)에서 확인할 수 있습니다.
43+

0 commit comments

Comments
 (0)