Skip to main content

Team wiki context hub for coding agents

Project description

piki

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

설치

pipx install piki-cli

시작하기

# 1) piki 설치
pipx install piki-cli

# 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 --dry-run
GITHUB_TOKEN=<token> piki init --org cmux-aim-netlog --wiki-repo wiki --source-repos Test_BE,Test_FE
# 기존 source repo의 piki 관리 파일을 유지하려면(덮어쓰기 비활성화):
GITHUB_TOKEN=<token> piki init --org cmux-aim-netlog --wiki-repo wiki --source-repos Test_BE,Test_FE --no-sync-source-files

# 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 --dry-run
# 실제 반영 시:
# GITHUB_TOKEN=<token> piki init --org cmux-aim-netlog --wiki-repo wiki --source-repos Test_BE,Test_FE
# source repo의 piki 관리 파일 자동 갱신을 끄려면:
# GITHUB_TOKEN=<token> piki init --org cmux-aim-netlog --wiki-repo wiki --source-repos Test_BE,Test_FE --no-sync-source-files
# 참고: init을 실행한 현재 레포와 wiki 레포는 source 대상에서 자동 제외됩니다.

skill

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

wiki

piki setup                      # 위키 초기 설정 (~/.wiki/ 에 클론)
piki sync                       # 최신 위키 pull + 인덱스 재생성
piki ingest                     # pull + index + graph-wiki.md 생성
piki ingest --retries 2         # pull 실패 시 재시도 후 fallback
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 context src/handlers/refund.ts

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

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

프로젝트 구조

piki/
├── piki/
│   ├── __init__.py          # 버전
│   ├── main.py              # CLI 진입점
│   ├── config.py            # 설정 파일 읽기/쓰기
│   ├── commands/
│   │   ├── config_cmd.py    # config 명령어
│   │   ├── wiki_cmd.py      # wiki 명령어
│   │   ├── init_cmd.py      # org 초기화 명령어
│   │   └── skill_cmd.py     # skill 설치 명령어
│   └── 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.7.tar.gz (36.5 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.7-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: piki_cli-0.1.7.tar.gz
  • Upload date:
  • Size: 36.5 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.7.tar.gz
Algorithm Hash digest
SHA256 491edf633e4dfb0dd2a6c9b07467088d9cb9cf745136db671dff14efad0f5b6a
MD5 896809c4437633d7941ac1d33e4de26c
BLAKE2b-256 6fbe43aea8eb6efc27dd269aec72d088fa39eb71acee1dbdad0005e2b23436ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for piki_cli-0.1.7.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.7-py3-none-any.whl.

File metadata

  • Download URL: piki_cli-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 38.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 52b5cda89e810ec8954d7dbf39c2a305618fb3243e87084cf57e76c9a1217c84
MD5 7f44afbefd64eedc9d40ffd74218f4d3
BLAKE2b-256 165c4f9ab8db48904158a16b8a52ccfa5e3ac94a8907c796e27624b9c3f982fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for piki_cli-0.1.7-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