Skip to main content
Glama
README.md
# Workroom

ChatGPT와 로컬 프로젝트를 연결해 파일과 작업을 관리하는 데스크톱 앱입니다.

## 기능

- 프로젝트별 폴더 연결과 접근 권한 설정
- 파일 읽기·생성·수정·삭제
- macOS 셸 명령 실행과 결과 확인
- 자동승인 또는 건별 승인, 자동승인 재시작 후 유지
- 작업 보드, 실행 기록, 활동 기록
- ChatGPT 터널 연결과 로컬 MCP 연결
- OS 환경변수 이름 허용 목록과 비밀파일 접근 차단

## 사용방법

### 1. 설치

[릴리즈 페이지](https://github.com/bingak36-creator/workroom/releases)에서 운영체제에 맞는 파일을 받으세요.

| 운영체제 | 설치 파일 |
|---|---|
| macOS Apple Silicon | [DMG](https://github.com/bingak36-creator/workroom/releases/download/v0.3.0-rc.4/Workroom-0.3.0-rc.4-arm64-preview.dmg)를 열고 Workroom을 응용 프로그램 폴더로 옮깁니다. |
| Windows x64 | [설치 프로그램](https://github.com/bingak36-creator/workroom/releases/download/v0.3.0-rc.4/Workroom-0.3.0-rc.4-x64-preview.exe)을 실행합니다. |

### 2. 프로젝트 연결

1. Workroom을 열고 **프로젝트 추가**를 누릅니다.
2. 작업할 폴더를 선택합니다.
3. **폴더 접근**에서 사용할 폴더를 승인합니다. `/`는 프로젝트 전체입니다.

### 3. 승인 방식 선택

| 승인 모드 | 동작 |
|---|---|
| 자동승인 | 승인한 폴더의 파일 변경·삭제와 macOS 명령을 자동 실행합니다. |
| 삭제만 승인 | 파일 변경은 자동 실행하고, 삭제와 명령은 실행 전에 확인합니다. |
| 전부 승인 | 모든 파일 변경·삭제와 명령을 실행 전에 확인합니다. |

**자동승인 시작**을 누르면 폴더 접근·변경 허용·자동승인을 함께 설정합니다. **앱을 다시 열 때도 이 프로젝트의 자동승인 유지**를 선택하면 다음 실행에도 유지됩니다. **자동승인 끄기**로 작업을 중지하고 읽기 전용으로 전환합니다.

건별로 확인하려면 **변경 허용**을 켜고 승인 모드를 선택하세요. 네트워크가 필요한 명령은 건별 승인 모드에서 실행합니다. 셸 명령은 macOS에서 사용할 수 있습니다.

### 4. ChatGPT 연결

1. **ChatGPT 연결** 화면을 엽니다.
2. 화면의 다운로드 안내로 `tunnel-client`를 설치하고 **설치 다시 확인**을 누릅니다.
3. 터널 ID와 런타임 API 키를 입력해 터널을 연결합니다.
4. **터널 ID 복사**와 **ChatGPT 플러그인 열기**를 눌러 화면 안내에 따라 Workroom을 등록합니다.

로컬 MCP 호스트를 사용한다면 같은 화면의 **연결 주소 복사**로 주소를 복사해 호스트의 MCP 설정에 등록하세요. 연결해서 작업하는 동안에는 Workroom을 켜 두세요.

### 5. 작업 요청과 결과 확인

프로젝트를 선택하고 **ChatGPT 시작 문구 복사**를 눌러 ChatGPT 대화에 붙여 넣습니다. 이어서 원하는 작업을 요청하세요.

- “프로젝트 파일 구조를 확인해 줘.”
- “README에 설치 방법을 추가해 줘.”
- “진행한 작업과 다음 할 일을 정리해 줘.”

**실행 기록**에서 요청을 승인·거절하고 결과를 확인합니다. 실행 중인 작업은 **취소 / 중지**, 전체 작업은 **일시 정지**로 멈출 수 있습니다.

### 환경변수 사용

프로젝트의 **명령에 허용할 OS 환경변수**에 `API_TOKEN, DATABASE_URL`처럼 허용할 이름만 입력합니다. ChatGPT에는 필요한 환경변수를 사용해 달라고 요청하세요. 값은 Workroom을 실행할 때 받은 OS 환경에서 가져옵니다.

### 소스 실행

Node.js 22.12 이상이 필요합니다.

```sh
npm ci
npm run build
npm start
```

Electron 설치가 생략됐다면 `npm run setup:electron`을 먼저 실행하세요. 개발 중에는 `npm run dev`를 사용합니다.