Vooster CLI

Cursor와 같은 AI 코딩 에이전트와 프로젝트 룰을 관리하기 위한 명령줄 인터페이스입니다.

시작하기

사전 요구사항

• Node.js (버전 14 이상)
• API 접근 권한이 있는 Vooster 프로젝트

설치

npm install -g @vooster/cli-test

초기 설정

1. 프로젝트 연결: 프로젝트 루트에 다음 구조의 .vooster/project.json 파일이 있어야 합니다:

   {
     "uid": "your-project-uid",
     "name": "Your Project Name",
     "description": "Project description",
     "connectedAt": "2024-01-01T00:00:00.000Z"
   }

2. API 키 획득: Vooster 플랫폼에서 API 키를 발급받으세요.

사용법

룰 초기화

Vooster 프로젝트에서 룰을 다운로드하고 설정합니다:

vooster rules:init --agent cursor --api-key YOUR_API_KEY

이 명령어는 다음을 수행합니다:

• Vooster 서버에서 룰을 가져옵니다
• 지정된 에이전트용 룰 파일을 생성합니다 (현재 Cursor 지원)
• 추적용 로컬 rules.json 파일을 생성합니다

룰 업로드

로컬 룰 변경사항을 Vooster 서버로 업로드합니다:

vooster rules:push --agent cursor --api-key YOUR_API_KEY

이 명령어는 다음을 수행합니다:

• 로컬 룰 파일을 읽습니다
• 서버로 변경사항을 업로드합니다
• 업로드된 룰의 요약을 표시합니다

지원하는 에이전트

• cursor: .cursor/rules/ 디렉토리에 적절한 frontmatter와 함께 .mdc 파일을 생성합니다

룰 타입

현재 지원하는 룰 타입:

• prd: 제품 요구사항 문서 룰

아키텍처 요약

핵심 구성요소

명령어 (src/commands/)

• rules-init.ts: 서버에서 룰을 다운로드하고 초기화 처리
• rules-push.ts: 로컬 룰을 서버로 업로드 처리
• _hof.ts: 미들웨어를 제공하는 고차 함수 (에러 처리, 프로젝트 검증)

API 레이어 (src/api/)

• _client.ts: 에러 처리가 포함된 Axios 기반 HTTP 클라이언트
• rules.ts: 룰 관련 API 엔드포인트 (가져오기/업로드 작업)

파일 관리 (src/utils/file/)

• base.ts: 구체적인 구현을 가진 추상 파일 시스템 인터페이스
• project-file.ts: .vooster/project.json 작업 처리
• rules-file.ts: 룰 파일 생성, 읽기, 파싱 관리
• constants.ts: 파일 경로 및 디렉토리 상수

유틸리티 (src/utils/)

• project.ts: 프로젝트 검증 및 UID 추출
• _error.ts: CLI 및 API 에러용 커스텀 에러 클래스

주요 기능

• 타입 안전성: TypeScript와 Zod 스키마 검증으로 구축
• 에이전트 추상화: 다양한 AI 코딩 에이전트를 위한 플러그형 아키텍처
• 에러 처리: 커스텀 에러 타입을 사용한 포괄적인 에러 처리
• 파일 시스템 추상화: 인터페이스 추상화를 통한 테스트 가능한 파일 작업
• 미들웨어 패턴: 조합 가능한 명령어 검증 및 에러 처리

파일 구조

.vooster/
├── project.json     # 프로젝트 설정
└── rules.json       # 로컬 룰 추적

.cursor/
└── rules/
    └── vooster__*.mdc  # Cursor용 생성된 룰 파일

룰 파일 형식

Cursor용 룰 파일은 다음 구조를 따릅니다:

---
description: 룰 설명
globs: *.ts
alwaysApply: true
---

마크다운 형식의 룰 내용