README_KOR.md

OKai 🤖

📖 문서 | 🎯 예시

✨ 기능

• 🛠 SNS 지원: 디스코드, 트위터, 텔레그램 모두 지원됩니다.
• 🔗 다양한 모델 지원 (Llama, Grok, OpenAI, Anthropic 등)
• 👥 다중 지원: 다중 에이전트 및 채팅방이 지원됩니다.
• 📚 높은 유연성: 개발자가 쉽게 데이터를 추가하고, 이를 활용해 다양한 기능을 만들 수 있습니다.
• 💾 검색 지원: 당신의 데이터와 작업을 쉽게 찾아볼 수 있도록, 검색 기능을 지원합니다.
• 🚀 높은 확장성: 자신의 동작과 클라이언트를 만들어 기능을 확장할 수 있습니다.
• ☁️ 다양한 AI 모델 지원: local Llama, OpenAI, Anthropic, Groq 등 다양한 AI 모델을 지원합니다
• 📦 즐겁게 개발해 봐요!

🎯 okai로 어떤걸 만들 수 있을까요?

• 🤖 챗봇 개발
• 🕵 ️AI가 자율적으로 결과를 만들어줘요!
• 📈 업무처리 자동화
• 🎮 비디오 게임 NPC
• 🧠 트레이딩

🚀 빠른 시작

필수 요구사항:

• Python 2.7+
• Node.js 23.3+
• pnpm

Windows 사용자 참고: WSL 2 필요.

Starter 사용 (권장)

git clone https://github.com/okcashpro/okai-starter.git

cp .env.example .env

pnpm i && pnpm start

문서를 참고하여 OKai를 커스마이징 방법을 확인하세요.

직접 실행하기 (경험자만 권장)

# 리포지토리 클론
git clone https://github.com/okcashpro/okai.git

# 최신 릴리스로 체크아웃
# 프로젝트가 빠르게 수정되므로 최신 릴리스를 체크아웃하는 것을 권장합니다.
git checkout $(git describe --tags --abbrev=0)

Gitpod로 OKai 시작

.env 파일 편집

.env.example을 복사해서 필요한 값들을 채워넣어 .env파일을 만드세요.

cp .env.example .env

참고: .env는 선택 사항입니다. 여러 개의 에이전트를 실행하려는 경우, 캐릭터 JSON 파일을 통해 비밀 변수를 전달할 수 있습니다.

OKai 자동 시작

아래 명령은 프로젝트를 설정하고 기본 캐릭터와 함께 봇을 시작합니다.

sh scripts/start.sh

character file 편집

1. agent/src/character.ts를 열어 기본 캐릭터를 수정하세요. 주석을 해제하고 수정하시면 됩니다.

2. 커스텀 캐릭터 로드하기:

   • pnpm start --characters="path/to/your/character.json"을 사용합니다.
   • 여러 캐릭터 파일을 동시에 로드할 수 있습니다.

3. X (Twitter) 연결:

   • 캐릭터 파일에서 "clients": []를 "clients": ["twitter"]로 변경합니다.

OKai 수동 시작

pnpm i
pnpm build
pnpm start

# 프로젝트가 빠르게 수정되므로 프로젝트를 clean해야 할 수도 있습니다.
pnpm clean

추가 요구 사항

시작 시 에러가 발생하면 Sharp를 설치해야 할 수 있습니다. 아래 명령어를 사용하여 설치하세요:

pnpm install --include=optional sharp

Community & contact

• 깃헙 이슈. 용도: OKai 사용 중 발견된 버그 리포트, 기능 제안.
• Discord. 용도: 애플리케이션 공유 및 커뮤니티 활동.

컨트리뷰터

스타 기록