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