Skip to content

sodam-ai/Neon-CLI_One-Click_Kit

Repository files navigation

Neon CLI 원클릭 키트 (Windows)

터미널을 몰라도 더블클릭만으로 Neon CLI(neonctl)를 설치·로그인·사용·완전 제거하는 키트입니다. Neon은 인터넷에 있는 무료 데이터베이스(서버리스 Postgres) 서비스이고, neonctl은 그것을 다루는 작은 도구예요.

한국어 ⟶ 이 문서 · English ⟶ README.en.md 처음이거나 막히면 → 왕초보_시작_가이드.md (아주 자세한 단계별 설명)


⚡ 빠른 시작 (3단계)

  1. 이 폴더의 시작하기.bat더블클릭.
  2. 검은 창에서 1 + Enter → 설치 (1~2분 기다림).
  3. 2 + Enter → 3(로그인) → 브라우저에서 Neon 로그인 → 끝.

준비물: 인터넷 되는 Windows 컴퓨터. (Node.js 같은 건 미리 안 깔아도 돼요 — 없으면 키트가 알아서 처리.) ZIP으로 받았다면 압축을 폴더째로 풀고, lib 폴더를 빼지 마세요.


🧰 사전 준비물 (필요 프로그램)

필수 (이게 다예요):

  • Windows 10 또는 11 — PowerShell이 기본 내장이라 따로 설치할 필요 없음.
  • 인터넷 연결 — 설치·로그인에 필요.
  • 웹 브라우저 — 로그인용. Windows 기본 Edge 로 충분(Chrome 등도 OK).

미리 안 깔아도 되는 것 (키트가 자동 처리):

  • Node.js — 있으면 npm 방식, 없으면 키트가 독립 실행 파일(.exe) 로 설치. 미리 설치 불필요.

선택 (특정 기능 쓸 때만):

  • Node.js 18+12) 빠른 자동 설정(init) 기능용 (npm 방식으로 깔리면 자동 충족).
  • Claude Code11) AI 연동(MCP) 기능용.

계정:

  • Neon 계정 — 무료. 없으면 3) 로그인 화면에서 바로 가입할 수 있어요.

📁 파일 설명

더블클릭하는 파일 하는 일 언제
시작하기.bat 설치/사용/진단/제거를 한곳에서 (출입구) 제일 먼저 / 헷갈릴 때
INSTALL.bat Neon CLI 설치 처음 한 번
RUN.bat 사용 메뉴 (로그인·프로젝트·DB·AI 연동) 평소 사용
자가진단.bat 점검 + 결과를 바탕화면 파일로 저장 문제 생겼을 때
UNINSTALL.bat 안전하게 완전 제거 지울 때

lib 폴더의 파일들은 위 버튼들이 사용하는 한국어 화면입니다. 폴더째로 두세요. .bat 만 더블클릭하세요. .ps1 은 버튼들이 알아서 씁니다.


🔧 설치 방식 (자동 선택)

  • 이 컴퓨터에 Node.js(18+) 가 있으면 → npm i -g neonctl (업데이트가 쉬움)
  • 없으면 → 독립 실행 파일(.exe) 을 키트 폴더에 받아서 사용 (Node 불필요)

둘 중 무엇으로 깔렸는지 키트가 기억해 두었다가, 업데이트·제거 때 알맞게 처리합니다.


🖥 사용 메뉴 (RUN.bat) — 17개 기능

  • 상태/시작: 쉬운 설명 · 설치/상태 확인
  • 로그인: 로그인 · 로그아웃 · 내 계정 보기
  • 프로젝트/DB: 프로젝트 목록 · 새 프로젝트 · 브랜치 목록 · DB 목록 · 연결 문자열 가져오기
  • AI 연동: Neon 을 Claude Code 에 연결(MCP) · 빠른 자동 설정(init)
  • 관리: 버전 확인 · 최신 업데이트 · 도움말 · 명령 직접 입력(고급) · 웹 콘솔 열기

메뉴 상단 상태줄(v2.26.1 | 로그인: 안 됨)과 "지금 추천: N)" 안내를 그대로 따라가면 됩니다. 각 메뉴의 상세 설명은 가이드 8장에 있어요.

로그인(3번)은 이렇게 동작해요

  • 키트가 로그인 주소(https://oauth2.neon.tech/...)를 화면에 크게 보여주고 브라우저를 직접 엽니다.
  • 브라우저가 안 열리면 그 주소를 복사해 직접 여세요. 로그인하면 자동으로 "로그인 성공".
  • 로그인은 브라우저(OAuth)로만 하며, 비밀번호·키를 파일에 저장하지 않습니다.

🆘 문제가 생기면

  1. 자가진단.bat 실행 → 점검 결과가 바탕화면\Neon키트_진단결과.txt 로 저장됩니다.
  2. 막히면 그 파일(또는 화면 캡처)을 보내 도움을 요청하세요.

자주 묻는 것:

  • 검은 창이 바로 사라져요lib 폴더가 통째로 있어야 합니다.
  • 3) 로그인 후 아무것도 안 열려요 → 화면의 로그인 주소를 복사해 직접 여세요. 예전 멈춘 창이 있으면 먼저 닫기.
  • Windows가 "확인되지 않은 앱" 경고추가 정보 → 실행.

더 많은 증상·해결은 가이드 11장.


🔒 안전

  • 사용 메뉴에는 삭제 같은 위험한(되돌릴 수 없는) 명령을 넣지 않았습니다.
  • 도구 제거는 UNINSTALL.bat 이 따로 담당하며, yes 를 입력해야만 실행됩니다.
  • 제거는 이 컴퓨터의 도구만 지웁니다. 인터넷(클라우드)의 실제 데이터베이스/프로젝트는 건드리지 않습니다.
  • 로그인/설정 정보까지 지우는 "완전 제거"는 한 번 더 따로 물어본 뒤에만 합니다.
  • 연결 문자열(10번) 에는 비밀번호가 들어 있으니 공유하지 마세요.

🗑 완전 제거

UNINSTALL.bat 더블클릭 → yes → (원하면) 로그인/설정 정보까지 yes → 끝.


📂 파일·위치 (참고)

무엇 위치
neonctl (npm 설치) %APPDATA%\npm
neonctl (바이너리 설치) %LOCALAPPDATA%\neon-cli-one-click-kit\bin
로그인 정보 %USERPROFILE%\.config\neonctl
진단 결과 파일 바탕화면\Neon키트_진단결과.txt

라이선스

Apache License 2.0 — © SoDam AI Studio

About

Windows 키트를 두 번 클릭하여 Neon(서버리스 Postgres) CLI를 설치, 로그인, 사용 및 완전히 제거할 수 있습니다. 초보자도 쉽게 이해할 수 있도록 한국어/영어 문서가 제공됩니다.

Topics

Resources

License

Stars

11 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors