빠른 시작

이 페이지에서는 설치부터 유용한 첫 번째 Pi 세션까지 안내합니다.

Pi는 npm 패키지로 배포됩니다.

npm install -g --ignore-scripts @earendil-works/pi-coding-agent

--ignore-scripts 설치 중에 종속성 수명 주기 스크립트를 비활성화합니다. Pi 일반 npm 설치에는 설치 스크립트가 필요하지 않습니다.

pi를 설치한 패키지 관리자를 사용하십시오. 컬 설치 프로그램은 npm를 전역적으로 사용하므로 컬 및 npm 설치는 npm를 사용하여 제거됩니다.

# curl installer or npm install -g
npm uninstall -g @earendil-works/pi-coding-agent

# pnpm
pnpm remove -g @earendil-works/pi-coding-agent

# Yarn
yarn global remove @earendil-works/pi-coding-agent

# Bun
bun uninstall -g @earendil-works/pi-coding-agent

pi를 제거하면 설정, 자격 증명, 세션 및 설치된 pi 패키지가 ~/.pi/agent/에 남습니다.

그런 다음 작업하려는 프로젝트 디렉터리에서 pi를 시작합니다.

cd /path/to/project
pi

Pi는 환경 변수나 인증 파일을 통해 subscription providers부터 /login까지 또는 API 키 공급자를 사용할 수 있습니다.

pi를 시작하고 다음을 실행합니다.

/login

그런 다음 공급자를 선택하십시오. 내장된 구독 로그인에는 Claude Pro/Max, ChatGPT Plus/Pro(Codex) 및 GitHub Copilot이 포함됩니다.

pi를 시작하기 전에 API key를 설정하세요.

export ANTHROPIC_API_KEY=sk-ant-...
pi

/login를 실행하고 API 키 공급자를 선택하여 ~/.pi/agent/auth.json에 키를 저장할 수도 있습니다.

지원되는 모든 공급자, 환경 변수 및 클라우드 공급자 설정은 Providers를 참조하세요.

pi가 시작되면 요청을 입력하고 Enter를 누릅니다.

Summarize this repository and tell me how to run its checks.

기본적으로 pi는 모델에 네 가지 도구를 제공합니다.

• read - 파일 읽기
• write - 파일 생성 또는 덮어쓰기
• edit - 패치 파일
• bash - 쉘 명령 실행

추가로 내장된 읽기 전용 도구(grep, find, ls)는 도구 옵션을 통해 사용할 수 있습니다. Pi 현재 작업 디렉터리에서 실행되며 거기에서 파일을 수정할 수 있습니다. 쉬운 롤백을 원한다면 git 또는 다른 체크포인트 워크플로를 사용하세요.

Pi는 시작 시 context files를 로드합니다. 프로젝트에서 작업하는 방법을 알려주려면 AGENTS.md 파일을 추가하세요.

# Project Instructions

- Run `npm run check` after code changes.
- Do not run production migrations locally.
- Keep responses concise.

Pi 로드:

• ~/.pi/agent/AGENTS.md 글로벌 지침
• AGENTS.md 또는 CLAUDE.md 상위 디렉토리 및 현재 디렉토리에서

디렉토리에 AGENTS.override.md가 포함되어 있으면 Pi는 해당 디렉토리에서 AGENTS.md 또는 CLAUDE.md 대신 해당 디렉토리를 로드합니다.

pi를 다시 시작하거나 context files를 변경한 후 /reload를 실행하세요.

편집기에서 @를 입력하여 파일을 유사 검색하거나 명령줄에 파일을 전달하세요.

pi @README.md "Summarize this"
pi @src/app.ts @src/app.test.ts "Review these together"

이미지나 텍스트는 Ctrl+V(Windows에서는 Alt+V)를 사용하여 붙여넣을 수 있습니다. 이미지를 지원되는 터미널로 드래그할 수도 있습니다.

대화형 모드에서:

!npm run lint

명령 출력이 모델로 전송됩니다. 모델 컨텍스트에 출력을 추가하지 않고 명령을 실행하려면 !!command를 사용하세요.

모델을 선택하려면 /model 또는 Ctrl+L을 사용하세요. 사고 수준을 순환하려면 Shift+Tab을 사용하세요. 범위가 지정된 모델을 순환하려면 Ctrl+P / Shift+Ctrl+P를 사용하세요.

세션은 자동으로 저장됩니다.

pi -c                  # Continue most recent session
pi -r                  # Browse previous sessions
pi --name "my task"    # Set session display name at startup
pi --session <path|id> # Open a specific session

pi 내부에서 /resume, /new, /tree, /fork 및 /clone를 사용하여 세션을 관리합니다.

일회성 프롬프트의 경우:

pi -p "Summarize this codebase"
cat README.md | pi -p "Summarize this text"
pi -p @screenshot.png "What's in this image?"

JSON 이벤트 출력에는 --mode json를 사용하고, 프로세스 통합에는 --mode rpc를 사용하세요.

• Using Pi - 대화형 모드, slash commands, 세션, context files 및 CLI 참조.
• Providers - 인증 및 모델 설정.
• Settings - 전역 및 프로젝트 구성.
• Keybindings - 바로가기 및 맞춤설정.
• Pi Packages - 공유 확장, 기술, 프롬프트 및 테마를 설치합니다.

플랫폼 참고 사항: Windows, Termux, tmux, Terminal setup, Shell aliases.