Examples · Discord · Youtube · Hub

Srcbook은 현재 활발하게 개발 중인 상태가 아닙니다.

Srcbook은 사용자의 로컬 머신에서 실행되는 TypeScript 노트북입니다.

Srcbook은 오픈 소스(apache2)이며 사용자의 로컬 머신에서 실행됩니다. AI 사용을 위해서는 사용자의 API 키를 직접 준비해야 합니다 (Anthropic의 claude-3-5-sonnet-latest 모델 사용을 강력히 권장합니다).

• TypeScript 노트북 생성, 실행 및 공유
• 유효한 마크다운 (markdown) 형식(.src.md)으로 내보내기
• 아이디어 탐색 및 반복을 위한 AI 기능
• 풍부한 주석을 위한 mermaid를 이용한 다이어그램 작성
• 웹 인터페이스를 통한 로컬 실행
• Node.js 기반

FAQ를 확인하세요.

Srcbook은 웹 인터페이스를 갖춘 CLI 애플리케이션으로서 사용자의 로컬 머신에서 실행됩니다.

• Node 18+ (로컬 Node 버전을 관리하기 위해 nvm 사용을 권장합니다)
• 패키지 매니저 (package manager) 버전을 관리하기 위한 corepack

항상 npm의 최신 버전을 실행하기 위해 npx를 사용하는 것을 권장합니다.

# npm 사용 시
npx srcbook@latest start
# 사용 중인 패키지 매니저(pm)에 맞춰 사용
...

대신 다음과 같이 전역 설치(global install)를 사용할 수도 있습니다.

<pkg manager> i -g srcbook

그 후 srcbook start로 직접 srcbook을 호출할 수 있습니다.

Docker를 사용하여 Srcbook을 실행할 수도 있습니다:

# Docker 이미지 빌드
docker build -t srcbook .
# 컨테이너 실행
...

컨테이너를 시작한 후 반드시 API 키를 설정하세요. http://localhost:2150에 있는 웹 인터페이스를 통해 설정할 수 있습니다.

$ srcbook -h
Usage: srcbook [options] [command]
Srcbook is a interactive programming environment for TypeScript
...

srcbook을 제거하려면 먼저 패키지를 삭제한 다음, 디스크의 로컬 디렉토리를 정리해야 합니다:

rm -rf ~/.srcbook
# 전역 설치를 구성한 경우
npm uninstall -g srcbook

다른 패키지 매니저(pm)를 사용했다면 해당 매니저의 특정 삭제 명령어를 사용해야 합니다.

Srcbook을 개선하기 위해, 저희는 일부 행동 분석 (behavioral analytics) 데이터를 수집합니다. 저희는 어떠한 개인 식별 정보 (PII)도 수집하지 않으며, 저희의 목표는 단순히 애플리케이션을 개선하는 것입니다. 코드는 오픈 소스 (open source)이므로 저희를 신뢰할 필요 없이 직접 검증할 수 있습니다! 더 자세한 정보는 개인정보 처리방침 (privacy policy)에서 확인하실 수 있습니다.

트래킹을 비활성화하고 싶다면, 환경 변수에 SRCBOOK_DISABLE_ANALYTICS=true를 설정하여 Srcbook을 실행하면 됩니다.

개발 지침은 CONTRIBUTING.md를 참조하세요.