Sidekick (Beta)

당신의 에이전트형 (agentic) CLI 개발자.

개요 (Overview)

Sidekick는 Claude Code, Copilot, Windsurf 및 Cursor에서 영감을 받은 에이전트형 (agentic) CLI 기반 AI 도구입니다. 이 도구들은 이러한 도구들에 대한 오픈 소스 대안을 목표로 하며, 에이전트형 (agentic) 워크플로우를 유지하면서도 다양한 LLM 제공업체 (Anthropic, OpenAI, Google Gemini)를 사용할 수 있는 유연성을 제공하여 유사한 경험을 제공합니다.

Sidekick는 현재 베타 버전이며 활발히 개발 중입니다. 이슈를 보고하거나 피드백을 공유해 주세요!

주요 기능 (Features)

• 특정 업체에 종속되지 않음 (No vendor lock-in). 선호하는 LLM 제공업체를 무엇이든 사용하세요.
• MCP 지원
• 동일한 세션 내에서 모델 간의 간편한 전환.
• JIT 스타일의 시스템 프롬프트 주입 (system prompt injection)을 통해 Sidekick이 맥락을 놓치지 않도록 보장합니다.
• 프로젝트별 가이드. 필요에 따라 Sidekick의 동작을 조정하세요.
• CLI 우선 설계. 번거로운 IDE를 버리세요.
• 비용 및 토큰 추적.
• 명령별 또는 세션별 확인 생략 기능.

로드맵 (Roadmap)

• 테스트 😅
• Ollama를 포함한 더 많은 LLM 제공업체 추가

빠른 시작 (Quick Start)

Sidekick을 설치하세요.

pip install sidekick-cli

처음 실행할 때, LLM 제공업체를 구성하라는 요청을 받게 됩니다.

sidekick

설정 (Configuration)

초기 설정 후, Sidekick은 ~/.config/sidekick.json에 설정 파일을 저장합니다. 필요에 따라 이 파일을 열고 편집할 수 있습니다. 향후 업데이트를 통해 Sidekick 내부에서 직접 편집하는 것이 더 쉬워질 예정입니다.

MCP 지원

Sidekick은 Model Context Protocol (MCP) 서버를 지원합니다. ~/.config/sidekick.json 파일에서 MCP 서버를 구성할 수 있습니다:

{
  "mcpServers": {
    "fetch": {
...

MCP 서버는 AI 어시스턴트의 기능을 확장하여 추가적인 도구 및 데이터 소스와 상호 작용할 수 있도록 합니다. MCP에 대한 자세한 내용은 modelcontextprotocol.io에서 확인하세요.

사용 가능한 명령 (Available Commands)

• /help - 사용 가능한 명령 표시
• /yolo - "yolo" 모드 토글 (도구 실행 확인 생략)
• /clear - 메시지 기록 삭제
• /model - 사용 가능한 모델 목록 표시
• /model <num> - 특정 모델로 전환 (인덱스 기준)
• /usage - 세션 사용 통계 표시
• exit - 애플리케이션 종료

사용자 정의 (Customization)

Sidekick은 "가이드 (guide)" 사용을 지원합니다. 이는 프로젝트 루트에 있는 SIDEKICK.md 파일로, Sidekick을 위한 지침을 포함합니다. 기술 스택 (tech stack), 프로젝트 구조, 개발 선호도 등을 지정하는 데 유용합니다.

텔레메트리 (Telemetry)

Sidekick은 오류 추적 및 사용 분석을 위해 Sentry를 사용합니다. --no-telemetry 플래그와 함께 시작하여 이 기능을 비활성화할 수 있습니다.

sidekick --no-telemetry

요구 사항 (Requirements)

• Python 3.10 이상
• Git (실행 취소 기능을 위해 필요)

설치 (Installation)

pip 사용

pip install sidekick-cli

소스에서 설치

1. 저장소(repository)를 클론(Clone)합니다.
2. 의존성 설치: pip install . (또는 개발용인 경우 pip install -e .)

개발 (Development)

# 개발 의존성 설치
make install

...

릴리스 프로세스 (Release Process)

새로운 릴리스를 준비할 때:

1. 다음 파일의 버전 번호를 업데이트합니다:

   • pyproject.toml
   • src/sidekick/constants.py (APP_VERSION)

2. 버전 변경 사항을 커밋(Commit)합니다:

   git add pyproject.toml src/sidekick/constants.py
   git commit -m "chore: bump version to X.Y.Z"
   

3. 태그(tag)를 생성하고 푸시(push)합니다:

   git tag vX.Y.Z
   git push origin vX.Y.Z
   

4. GitHub 릴리스를 생성합니다:

   gh release create vX.Y.Z --title "vX.Y.Z" --notes "Release notes here"
   

5. main 브랜치로 머지(Merge)하고 푸시하여 PyPI 릴리스를 트리거합니다 (자동화됨)

커밋 컨벤션 (Commit Convention)

이 프로젝트는 커밋 메시지에 대해 Conventional Commits 사양을 따릅니다:

• feat: - 새로운 기능 (New features)
• fix: - 버그 수정 (Bug fixes)
• docs: - 문서 변경 (Documentation changes)
• style: - 코드 스타일 변경 (Code style changes (formatting, etc.))
• refactor: - 코드 리팩터링 (Code refactoring)
• perf: - 성능 개선 (Performance improvements)
• test: - 테스트 추가 또는 수정 (Test additions or modifications)
• chore: - 유지 관리 작업 (Maintenance tasks (version bumps, etc.))
• build: - 빌드 시스템 변경 (Build system changes)
• ci: - CI 설정 변경 (CI configuration changes)

링크 (Links)

• PyPI 패키지 (PyPI Package)
• GitHub 이슈 (GitHub Issues)
• GitHub 저장소 (GitHub Repository)

라이선스 (License)

MIT