Skip to main content

Team wiki context hub for coding agents

Project description

piki

팀 위키를 코딩 에이전트에게 연결하는 CLI 도구입니다.

설치

pip install -e .

쌩초보 기준 빠른 시작

# 1) piki 설치
pip install -e .

# 2) skill + llm-wiki.md 설치 (현재 프로젝트 폴더에 복사)
piki install

# 3) GitHub Org 초기화 (단일 wiki repo + source repo 액션 설정)
#    GITHUB_TOKEN은 쉘 환경변수로만 주입 (코드/깃에 절대 저장 금지)
GITHUB_TOKEN=<token> piki init --org cmux-aim-netlog --wiki-repo wiki --source-repos Test_BE,Test_FE,piki --dry-run
GITHUB_TOKEN=<token> piki init --org cmux-aim-netlog --wiki-repo wiki --source-repos Test_BE,Test_FE,piki

# 4) ingest 1회 실행 (graph-wiki 생성)
piki ingest

# 5) 의사결정 이력 로컬 포트로 보기
piki serve --port 8787

명령어

bootstrap

piki init --org cmux-aim-netlog --wiki-repo wiki --source-repos Test_BE,Test_FE,piki --dry-run
# 실제 반영 시:
# GITHUB_TOKEN=<token> piki init --org cmux-aim-netlog --wiki-repo wiki --source-repos Test_BE,Test_FE,piki

skill

piki install                    # SKILL.md + llm-wiki.md 설치
piki install --target-dir .     # 특정 디렉터리에 설치

ingest / serve

piki ingest                     # pull + index + graph-wiki.md 생성
piki ingest --retries 2         # pull 실패 시 재시도 후 fallback
piki serve --port 8787          # 로컬에서 wiki 확인

wiki

piki setup                   # 위키 초기 설정 (~/.wiki/ 에 클론)
piki sync                    # 최신 위키 pull + 인덱스 재생성
piki ingest                  # 최신 반영 + graph-wiki.md 생성
piki search <query>          # 전체 문서 전문 검색
piki read <path>             # 특정 페이지 읽기 (예: repos/auth-service/gotchas)
piki context <files...>      # 편집할 파일과 관련된 위키 페이지 조회
piki gotchas <repo>          # 해당 레포의 알려진 함정/금지 패턴 조회
piki adr [--topic <topic>]   # 아키텍처 결정 기록(ADR) 목록/검색
piki serve --port 8787       # 로컬 포트로 wiki 탐색

config

piki config list           # 설정 전체 조회
piki config get <key>      # 특정 설정 값 조회
piki config set <key> <value>   # 설정 값 저장
piki config delete <key>   # 설정 키 삭제
piki config reset          # 설정 초기화

에이전트와 함께 사용하기

SKILL.md를 프로젝트 루트에 두면 Claude Code 등 코딩 에이전트가 코드 작성 전 자동으로 위키를 참조합니다.

# 파일 편집 전
piki wiki context src/handlers/refund.ts

# 아키텍처/도메인 질문 전
piki wiki search "payment v2 migration"

# 결제·인증 코드 작성 전
piki wiki gotchas auth-service

프로젝트 구조

piki/
├── piki/
│   ├── __init__.py          # 버전
│   ├── main.py              # CLI 진입점
│   ├── config.py            # 설정 파일 읽기/쓰기
│   ├── commands/
│   │   ├── config_cmd.py    # config 명령어
│   │   └── wiki_cmd.py      # wiki 명령어
│   └── wiki/
│       ├── __init__.py      # WIKI_DIR, WIKI_REPO 상수
│       ├── db.py            # SQLite FTS 인덱스 관리
│       └── render.py        # 터미널 렌더링
├── SKILL.md                 # 에이전트용 위키 참조 규칙
└── pyproject.toml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

piki_cli-0.1.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

piki_cli-0.1.0-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file piki_cli-0.1.0.tar.gz.

File metadata

  • Download URL: piki_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for piki_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 04ee59a77e3d0d3c8f878f231cfa2621a932ec5c1d252a6b1361193ce6d56b8c
MD5 6ab1d47922a26adead8fc555763c0aff
BLAKE2b-256 7d4cad68e18b9cba118ada7293ea51e3f26ab56cc312a722bf88f69777c3bffd

See more details on using hashes here.

Provenance

The following attestation bundles were made for piki_cli-0.1.0.tar.gz:

Publisher: publish.yml on cmux-aim-netlog/piki

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file piki_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: piki_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for piki_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b66eb6f88fab85e384949ee5696724ec69e249a132f93f4567c09cc2a40d7a0a
MD5 049527b9483d8c61209cfd80fb6df73e
BLAKE2b-256 38407311c66f2d563640e4c43ee82b2e186ca4f5b9185663b2cb9c07e2dca22f

See more details on using hashes here.

Provenance

The following attestation bundles were made for piki_cli-0.1.0-py3-none-any.whl:

Publisher: publish.yml on cmux-aim-netlog/piki

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page