jotbot

JOTBOT -AI 기반 코드 문서

JotBot GO 및 TypeScript 프로젝트에 대한 코드 문서를 완벽하게 자동 생성하여 포괄적 인 코드와 통찰력있는 문서 사이의 격차를 해소합니다.

이 저장소의 문서는 gpt-4 사용하여 JOTBOT에 의해 완전히 생성되었지만 현재 (2023/07/18) gpt-3.5-turbo 사용하여 최상의 결과를 얻습니다.

OpenAi의 gpt-3.5 및 gpt-4 모델은 시간이 지남에 따라 품질의 변동을 보여줍니다. 주어진 인스턴스에서 어떤 모델을 탁월한지를 결정하는 것은 어려울 수 있지만 gpt-4 종종 더 일관된 결과를 산출합니다.

일반적인 응용 프로그램의 경우 gpt-3.5-turbo-16k 기본값으로 사용하고 gpt-3.5 부족한 시나리오에서 gpt-4 로 전환하는 것이 좋습니다.

gpt-4-1106-preview 지금까지 문서를 생성하기위한 최고의 모델입니다. JOTBOT의 기본 모델은 gpt-3.5-turbo 이며, 이는 최상의 가치를 제공합니다.

패키지/jotbot에서 생성 된 TypeScript 문서를 찾을 수 있습니다.

빠른 시작

설치하다

 go install github.com/modernice/jotbot/cmd/jotbot@latest

TypeScript 지원을 추가하십시오

 npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest

사용

이동 및/또는 TypeScript Codebase 내에서 실행 :

 jotbot generate --key OPENAI_API_KEY

---

특징

• GO 및 TypeScript 코드베이스에 대한 문서를 생성합니다
• 포함 및 제외 된 파일에 대한 글로벌 패턴을 사용자 정의하십시오
• 정규 표현식을 일치시켜 필터 코드 기호
• 문서를 생성 할 파일 수를 제한하십시오
• 적용하지 않고 변경 사항을 미리보기 위해 건식 모드로 실행하십시오.
• 문서 생성에 사용되는 AI 모델 및 토큰 제한 제어
• 선택적으로 GIT 지점에 변경 사항을 커밋합니다

모델

JOTBOT는 OpenAI의 GPT 모델을 사용하여 문서를 생성합니다. 기본적으로 JOTBOT는 gpt-3.5-turbo 모델을 사용하여 비용 효율적인 속도로 좋은 결과를 제공합니다. 그러나 최상의 결과는 gpt-4 및 text-davinci-003 에 의해 생성되며, 이는 gpt-3.5-turbo 보다 ​​10-30 배 더 비쌉니다.

OpenAi 문서에서 모든 모델을 자유롭게 선택하고 --model|-m 플래그를 통해 전달할 수 있습니다.

 jotbot generate -m text-davinci-003

설치

go install 통해

설치 한 경우 GO go install 사용하여 JOTBOT를 설치하면됩니다.

 go install github.com/modernice/jotbot/cmd/jotbot@latest

독립형 바이너리

릴리스 페이지에서 최신 바이너리를 다운로드 할 수 있습니다.

타입 스크립트 지원

TypeScript (및 JavaScript) 지원을 활성화하려면 jotbot-ts NPM 패키지도 설치해야합니다.

 npm install -g jotbot-ts
pnpm install -g jotbot-ts

용법

코드베이스에 대한 누락 된 문서를 생성하려면 다음 명령을 실행하십시오.

 jotbot generate [options]

기본적 으로이 명령은 현재 및 중첩 된 디렉토리에서 모든 GO 및 TypeScript (및 JavaScript) 파일을 찾아서 문서를 생성합니다. 검색에서 제외는 기본적으로 다음과 같습니다.

• **/.*/**
• **/dist/**
• **/node_modules/**
• **/vendor/**
• **/testdata/**
• **/test/**
• **/tests/**
• **/*.pb.go

할 일

• 구성 가능한 OpenAI 설정 (온도, TOP_P 등)
• 어떤 아이디어가 있습니까? 문제를 열거나 토론을 시작하십시오

CLI 옵션

 jotbot --help

옵션	설명	기본
--root	저장소의 루트 디렉토리	"."
--include, -i	파일을 포함하는 글로벌 패턴
--include-tests, -T	testxxx () 함수 포함 (go-specific)
--exclude, -e	파일을 제외하기위한 글로벌 패턴
--exclude-internal, -E	'내부'디렉토리 제외 (Go-Specific)	true
--match	식별자와 일치하는 정규 표현
--symbol, -s	코드에서 검색 할 기호 (TS/JS- 특이)
--clear, -c	세대 프롬프트의 강제 댓글 (Go-Specific)
--branch	변경 사항을 저지르는 지점 이름 (커밋하지 않도록 비워 두는 남겨 둡니다)
--limit	문서를 생성 할 파일 수를 제한하십시오	0
--dry	변경하지 않고 변경 사항을 인쇄하십시오	false
--model, -m	문서를 생성하는 데 사용되는 OpenAI 모델	"gpt-3.5-turbo"
--maxTokens	단일 문서를 위해 생성 할 최대 토큰 수	512
--parallel, -p	동시에 처리 할 파일 수	4
--workers	파일 당 사용할 근로자 수	2
--override, -o	기존 문서 재정의 (Go-Specific)
--key	Openai API 키
--verbose, -v	장점 로깅을 활성화하십시오	false

스크린 샷

특허

MIT