gcx

(★ 561)

A CLI for managing Grafana and Grafana Cloud resources. Optimized for agentic usage.

  • .gitignore
  • .gitmessage
  • .golangci.yaml
  • .goreleaser.yaml
  • .markdownlint.json
  • .release-notes.md
  • AGENTS.md
  • ARCHITECTURE.md
  • catalog-info.yaml
  • CHANGELOG.md
  • CLAUDE.md
  • CONSTITUTION.md
  • CONTRIBUTING.md
  • DESIGN.md
  • docker-compose.yml
  • gcx.png
  • go.mod
  • go.sum
  • graph_example.png
  • LICENSE
  • mise.toml
  • mkdocs.yml
  • README.md
  • renovate.json
  • requirements.txt
  • VISION.md

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/grafana/gcx

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd gcx

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천
사전 준비물
  • Homebrew macOS/Linux용 패키지 매니저입니다.
  • Go go install 명령어를 쓰려면 Go가 필요합니다.
curl -fsSL https://raw.githubusercontent.com/grafana/gcx/main/scripts/install.sh | sh

공식 설치 스크립트를 다운로드해서 바로 실행합니다. 이 한 줄로 필요한 게 자동으로 설치됩니다.

brew install gcx

Homebrew로 이미 빌드된 패키지를 바로 설치합니다. 소스 빌드가 필요 없습니다.

brew install grafana/grafana/gcx

Homebrew로 이미 빌드된 패키지를 바로 설치합니다. 소스 빌드가 필요 없습니다.

go install github.com/grafana/gcx/cmd/gcx@latest

지정된 버전을 바로 다운로드해서 설치합니다. 레포를 직접 클론할 필요가 없습니다.

설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Docker

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker compose up -d --build

정의된 모든 컨테이너(서버, DB 등)를 한 번에 빌드하고 백그라운드에서 실행합니다.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

4. Python

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).
pip install -r requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

파이썬 스크립트(또는 모듈)를 실행합니다.

에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

5. Go

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Go Go 언어 컴파일러 및 도구 모음입니다.
go install github.com/grafana/gcx/cmd/gcx@latest

지정된 버전을 바로 다운로드해서 설치합니다. 레포를 직접 클론할 필요가 없습니다.

go run . && gcx resources push -p ./resources

따로 빌드하지 않고 바로 Go 프로그램을 실행합니다.

빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation