Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# arcusctl

`arcusctl`은 [ARCUS](https://github.com/naver/arcus)의 μš΄μ˜μ„ μœ„ν•΄ ν•„μš”ν•œ κΈ°λŠ₯을 μ œκ³΅ν•˜λŠ” CLI λ„κ΅¬μž…λ‹ˆλ‹€.

## Getting started

### Install

μ•„λž˜μ™€ 같은 λ°©λ²•μœΌλ‘œ arcusctl μ„€μΉ˜ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

- [Release Page](https://github.com/jam2in/arcusctl/releases)μ—μ„œ λ§žλŠ” pre-built binary λ‹€μš΄λ‘œλ“œν•  수 μžˆμŠ΅λ‹ˆλ‹€.
```sh
curl -LO https://github.com/jam2in/arcusctl/releases/download/v<VERSION>/arcusctl-<VERSION>.<OS>-<ARCH>.tar.gz
tar zxvf arcusctl-<VERSION>.<OS>-<ARCH>.tar.gz
cd arcusctl-<VERSION>.<OS>-<ARCH>
./arcusctl version
```

- Go toolchain이 μ„€μΉ˜λœ ν™˜κ²½μ—μ„œλŠ” `go install` ν™œμš©ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
```sh
go install github.com/jam2in/arcusctl@latest
arcusctl version
```

- λ˜λŠ” docker image ν™œμš©ν•˜μ—¬ μ‹€ν–‰ κ°€λŠ₯ν•©λ‹ˆλ‹€.
```sh
docker run --rm jam2in/arcusctl:latest version
```

### Usage

- help μ˜΅μ…˜μœΌλ‘œ arcusctlμ—μ„œ μ‚¬μš© κ°€λŠ₯ν•œ λͺ…λ Ήκ³Ό μ‚¬μš© 방법을 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.
```sh
./arcusctl -h
```

- μ•„λž˜μ™€ 같이 completion μ μš©ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
```sh
source <(./arcusctl completion bash)
```

- κ·Έ μ™Έ 각 λͺ…령에 λŒ€ν•œ κ°€μ΄λ“œλŠ” [λ¬Έμ„œ](docs)μ—μ„œ 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.

Loading