cocoindex-code

(โ˜… 2,667)

A super light-weight embedded code search engine CLI (AST based) that just works - improves speed and efficiency for coding agent ๐ŸŒŸ Star if you like it!

  • .dockerignore
  • .gitignore
  • .mcp.json
  • .pre-commit-config.yaml
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • EMBEDDINGS.md
  • LICENSE
  • pyproject.toml
  • README.md
  • req-to-pr.zip
  • SECURITY.md
  • uv.lock

# ์„ค์น˜ ๊ฐ€์ด๋“œ

1. ์ฝ”๋“œ ๋‚ด๋ ค๋ฐ›๊ธฐ
git clone https://github.com/cocoindex-io/cocoindex-code

๊นƒํ—ˆ๋ธŒ์—์„œ ํ”„๋กœ์ ํŠธ ์ฝ”๋“œ ์ „์ฒด๋ฅผ ๋‚ด ์ปดํ“จํ„ฐ๋กœ ๋‚ด๋ ค๋ฐ›์Šต๋‹ˆ๋‹ค.

cd cocoindex-code

๋ฐฉ๊ธˆ ๋‚ด๋ ค๋ฐ›์€ ํ”„๋กœ์ ํŠธ ํด๋” ์•ˆ์œผ๋กœ ์ด๋™ํ•ฉ๋‹ˆ๋‹ค.

2. ๊ณต์‹ ์„ค์น˜ ์Šคํฌ๋ฆฝํŠธ

์‰ฌ์›€ ์ถ”์ฒœ
์‚ฌ์ „ ์ค€๋น„๋ฌผ
  • pipx Python์œผ๋กœ ๋งŒ๋“  CLI ๋„๊ตฌ๋ฅผ ๊ฒฉ๋ฆฌ๋œ ํ™˜๊ฒฝ์— ์„ค์น˜ํ•ด์ฃผ๋Š” ๋„๊ตฌ์ž…๋‹ˆ๋‹ค.
  • Homebrew macOS/Linux์šฉ ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ €์ž…๋‹ˆ๋‹ค.
pipx install 'cocoindex-code[full]' # batteries included (local embeddings)

pipx๋กœ ๊ฒฉ๋ฆฌ๋œ ํ™˜๊ฒฝ์— CLI ๋„๊ตฌ๋ฅผ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค.

brew install python3

Homebrew๋กœ ์ด๋ฏธ ๋นŒ๋“œ๋œ ํŒจํ‚ค์ง€๋ฅผ ๋ฐ”๋กœ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค. ์†Œ์Šค ๋นŒ๋“œ๊ฐ€ ํ•„์š” ์—†์Šต๋‹ˆ๋‹ค.

pipx install cocoindex-code # first install

pipx๋กœ ๊ฒฉ๋ฆฌ๋œ ํ™˜๊ฒฝ์— CLI ๋„๊ตฌ๋ฅผ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค.

โœ… ์„ค์น˜ ํ›„ ์ƒˆ ํ„ฐ๋ฏธ๋„์„ ์—ด๊ณ , ํ”„๋กœ๊ทธ๋žจ์˜ ๋ฒ„์ „ ํ™•์ธ ๋ช…๋ น(์˜ˆ: --version)์œผ๋กœ ์ •์ƒ ์„ค์น˜๋๋Š”์ง€ ํ™•์ธํ•˜์„ธ์š”.

์ด ๋ ˆํฌ์˜ README์— ์ ํžŒ ์‹ค์ œ ๋ช…๋ น์–ด๋ฅผ ๊ทธ๋Œ€๋กœ ๊ฐ€์ ธ์™”์Šต๋‹ˆ๋‹ค.

3. Docker

์‰ฌ์›€
์‚ฌ์ „ ์ค€๋น„๋ฌผ
  • Git GitHub์—์„œ ํ”„๋กœ์ ํŠธ ์ฝ”๋“œ๋ฅผ ๋‚ด๋ ค๋ฐ›์œผ๋ ค๋ฉด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.
  • Docker Desktop ์ปจํ…Œ์ด๋„ˆ๋ฅผ ๋นŒ๋“œํ•˜๊ณ  ์‹คํ–‰ํ•˜๋ ค๋ฉด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. ์„ค์น˜ ํ›„ ์‹คํ–‰ํ•ด์„œ ๋ฐฑ๊ทธ๋ผ์šด๋“œ์— ์ผœ๋‘์„ธ์š”.
docker compose -f <(curl -L https://raw.githubusercontent.com/cocoindex-io/cocoindex-code/refs/heads/main/docker/docker-compose.yml) up -d

compose ์„ค์ • ํŒŒ์ผ์— ์ •์˜๋œ ์„œ๋น„์Šค๋“ค์„ ๋Œ€์ƒ์œผ๋กœ ๋ช…๋ น์„ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

PUID=$(id -u) PGID=$(id -g) docker compose -f <(curl -L https://raw.githubusercontent.com/cocoindex-io/cocoindex-code/refs/heads/main/docker/docker-compose.yml) up -d

compose ์„ค์ • ํŒŒ์ผ์— ์ •์˜๋œ ์„œ๋น„์Šค๋“ค์„ ๋Œ€์ƒ์œผ๋กœ ๋ช…๋ น์„ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

> COCOINDEX_CODE_IMAGE=cocoindex/cocoindex-code:full docker compose up -d

์ •์˜๋œ ๋ชจ๋“  ์ปจํ…Œ์ด๋„ˆ(์„œ๋ฒ„, DB ๋“ฑ)๋ฅผ ํ•œ ๋ฒˆ์— ๋นŒ๋“œํ•˜๊ณ  ๋ฐฑ๊ทธ๋ผ์šด๋“œ์—์„œ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

> COCOINDEX_CODE_IMAGE=ghcr.io/cocoindex-io/cocoindex-code:latest docker compose up -d

์ •์˜๋œ ๋ชจ๋“  ์ปจํ…Œ์ด๋„ˆ(์„œ๋ฒ„, DB ๋“ฑ)๋ฅผ ํ•œ ๋ฒˆ์— ๋นŒ๋“œํ•˜๊ณ  ๋ฐฑ๊ทธ๋ผ์šด๋“œ์—์„œ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

docker run -d --name cocoindex-code \

๋นŒ๋“œ๋œ ์ด๋ฏธ์ง€๋ฅผ ์‹ค์ œ ์ปจํ…Œ์ด๋„ˆ๋กœ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

โœ… ํ„ฐ๋ฏธ๋„์— docker compose ps ๋ฅผ ์ž…๋ ฅํ•ด ์ปจํ…Œ์ด๋„ˆ๋“ค์ด Up ์ƒํƒœ์ธ์ง€ ํ™•์ธํ•˜์„ธ์š”. README์— ํฌํŠธ ๋ฒˆํ˜ธ๊ฐ€ ์ ํ˜€์žˆ๋‹ค๋ฉด ๋ธŒ๋ผ์šฐ์ €์—์„œ http://localhost:ํฌํŠธ๋ฒˆํ˜ธ ๋กœ ์ ‘์†ํ•ด๋ณด์„ธ์š”.

์ด ๋ ˆํฌ์˜ README์— ์ ํžŒ ์‹ค์ œ ๋ช…๋ น์–ด๋ฅผ ๊ทธ๋Œ€๋กœ ๊ฐ€์ ธ์™”์Šต๋‹ˆ๋‹ค.

4. Python

์‰ฌ์›€
์‚ฌ์ „ ์ค€๋น„๋ฌผ
  • Git GitHub์—์„œ ํ”„๋กœ์ ํŠธ ์ฝ”๋“œ๋ฅผ ๋‚ด๋ ค๋ฐ›์œผ๋ ค๋ฉด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.
  • Python 3 ์„ค์น˜ ์‹œ 'Add Python to PATH' ์˜ต์…˜์„ ๊ผญ ์ฒดํฌํ•˜์„ธ์š” (Windows).
pip install .

PyPI์— ๋ฐฐํฌ๋œ ํŒจํ‚ค์ง€๋ฅผ ๋ฐ”๋กœ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค. ์†Œ์Šค ํด๋ก ์ด ํ•„์š” ์—†์Šต๋‹ˆ๋‹ค.

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

ํŒŒ์ด์ฌ ์Šคํฌ๋ฆฝํŠธ(๋˜๋Š” ๋ชจ๋“ˆ)๋ฅผ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

โœ… ์—๋Ÿฌ ๋ฉ”์‹œ์ง€ ์—†์ด ์‹คํ–‰๋˜๊ณ  ํ„ฐ๋ฏธ๋„์— ์•ˆ๋‚ด ๋ฌธ๊ตฌ๊ฐ€ ์ถœ๋ ฅ๋˜๋ฉด ์ •์ƒ์ž…๋‹ˆ๋‹ค.
// repository documentation