failproofai 0.0.6-beta.3 → 0.0.6-beta.5

package/.next/standalone/docs/ko/cli/install-policies.mdx

@@ -1,47 +0,0 @@
----
-title: 정책 설치
-description: "에이전트의 모든 도구 호출에서 정책이 실행되도록 활성화합니다"
----
-
-```bash
-failproofai policies --install [policy-names...] [options]
-```
-
-Claude Code의 `settings.json`에 훅 항목을 작성하여 failproofai가 도구 호출을 가로챌 수 있도록 합니다.
-
-별칭: `failproofai p -i`
-
-## 옵션
-
-| 플래그 | 설명 |
-|------|-------------|
-| `--scope user` | `~/.claude/settings.json`에 설치 (기본값 - 모든 세션에 적용) |
-| `--scope project` | 현재 디렉터리의 `.claude/settings.json`에 설치 |
-| `--scope local` | 현재 디렉터리의 `.claude/settings.local.json`에 설치 |
-| `--custom <path>` / `-c` | 커스텀 훅 정책이 포함된 JS 파일 경로 |
-
-## 동작 방식
-
-- **정책 이름 미지정** - 정책을 선택할 수 있는 대화형 프롬프트가 열립니다
-- **특정 이름 지정** - 해당 정책을 활성화합니다 (이미 활성화된 정책에 추가됨)
-- **`all`** - 사용 가능한 모든 정책을 활성화합니다
-
-설치는 누적 방식으로 동작합니다. `--install`을 다시 실행하면 기존 정책을 제거하지 않고 새 정책을 추가합니다.
-
-## 예시
-
-```bash
-# 전역에 모든 기본 정책 설치 (대화형)
-failproofai policies --install
-
-# 현재 프로젝트에 특정 정책 설치
-failproofai policies --install block-sudo sanitize-api-keys --scope project
-
-# 모든 정책을 한 번에 활성화
-failproofai policies --install all
-
-# 커스텀 정책 파일과 함께 설치
-failproofai policies --install --custom ./my-policies.js
-```
-
-`--custom <path>`가 제공되면 해당 파일이 즉시 유효성 검사를 거칩니다. 파일은 `customPolicies.add()`를 최소 한 번 이상 호출해야 합니다. 확인된 경로는 `customPoliciesPath`로 `policies-config.json`에 저장됩니다.

package/.next/standalone/docs/ko/cli/list-policies.mdx

@@ -1,31 +0,0 @@
----
-title: 정책 목록 보기
-description: "활성화된 정책, 해당 파라미터, 커스텀 정책을 확인합니다"
----
-
-```bash
-failproofai policies
-```
-
-모든 정책의 상태, 설정된 파라미터, 커스텀 정책을 표시합니다.
-
-## 출력 예시
-
-```text
-Failproof AI Hook Policies (user)
-
-  Status  Name                          Description
-  ──────  ──────────────────────────────────────────────────────────────
-  ✓       block-sudo                    Block sudo commands
-            allowPatterns: ["sudo systemctl status"]
-  ✓       block-rm-rf                   Block recursive deletions
-  ✗       block-curl-pipe-sh            Block curl|bash patterns
-  ✓       sanitize-api-keys             Redact API keys from output
-            additionalPatterns: [{ regex: "MY_TOKEN_...", label: "..." }]
-
-  ── Custom Policies (/home/alice/myproject/my-policies.js) ──────────────
-  ✓       require-jira-ticket           Block commits without ticket
-  ✓       approval-gate                 Approval gate for destructive ops
-```
-
-`policyParams`에 알 수 없는 키가 있으면 여기서 표시되므로, 오타를 조기에 발견할 수 있습니다.

package/.next/standalone/docs/ko/cli/remove-policies.mdx

@@ -1,43 +0,0 @@
----
-title: 정책 제거
-description: "Claude Code의 설정에서 훅 항목 제거"
----
-
-```bash
-failproofai policies --uninstall [policy-names...] [options]
-```
-
-Claude Code의 `settings.json`에서 failproofai 훅 항목을 제거합니다.
-
-별칭: `failproofai p -u`
-
-## 옵션
-
-| 플래그 | 설명 |
-|------|-------------|
-| `--scope user` | 전역 설정에서 제거 (기본값) |
-| `--scope project` | 프로젝트 설정에서 제거 |
-| `--scope local` | 로컬 설정에서 제거 |
-| `--scope all` | 모든 범위에서 한 번에 제거 |
-| `--custom` / `-c` | 설정에서 `customPoliciesPath` 초기화 |
-
-## 동작 방식
-
-- **정책 이름 미지정** - 설정 파일에서 모든 failproofai 훅 항목을 제거합니다
-- **특정 이름 지정** - 해당 정책은 비활성화하지만 훅은 설치된 상태로 유지합니다
-
-## 예시
-
-```bash
-# 전역에서 모든 훅 제거
-failproofai policies --uninstall
-
-# 특정 정책 비활성화 (훅은 설치 상태 유지)
-failproofai policies --uninstall block-sudo
-
-# 모든 범위에서 훅 제거
-failproofai policies --uninstall --scope all
-
-# 커스텀 정책 경로 초기화
-failproofai policies --uninstall --custom
-```

package/.next/standalone/docs/ko/cli/version.mdx

@@ -1,12 +0,0 @@
----
-title: 버전 확인
-description: "설치된 failproofai 버전 출력"
----
-
-```bash
-failproofai --version
-# or
-failproofai -v
-```
-
-설치된 버전 번호를 출력합니다.

package/.next/standalone/docs/ko/configuration.mdx

@@ -1,222 +0,0 @@
----
-title: 설정
-description: "설정 파일 형식, 세 가지 범위 시스템, 그리고 병합 규칙"
-icon: gear
----
-
-failproofai는 JSON 설정 파일을 사용하여 어떤 정책을 활성화할지, 정책이 어떻게 동작할지, 그리고 커스텀 정책을 어디서 불러올지를 제어합니다. 설정은 팀과 공유하기 쉽도록 설계되어 있습니다. 저장소에 커밋하면 모든 개발자가 동일한 에이전트 안전망을 갖게 됩니다.
-
----
-
-## 설정 범위
-
-우선순위 순서로 평가되는 세 가지 설정 범위가 있습니다:
-
-| 범위 | 파일 경로 | 용도 |
-|------|-----------|------|
-| **project** | `.failproofai/policies-config.json` | 저장소별 설정, 버전 관리에 커밋 |
-| **local** | `.failproofai/policies-config.local.json` | 개인 저장소별 재정의, gitignore 처리 |
-| **global** | `~/.failproofai/policies-config.json` | 모든 프로젝트에 적용되는 사용자 수준 기본값 |
-
-failproofai가 훅 이벤트를 수신하면, 현재 작업 디렉터리에 존재하는 세 파일을 모두 불러와 병합합니다.
-
-### 병합 규칙
-
-**`enabledPolicies`** - 세 범위 모두의 합집합입니다. 어느 레벨에서든 활성화된 정책은 유효합니다.
-
-```text
-project:  ["block-sudo"]
-local:    ["block-rm-rf"]
-global:   ["block-sudo", "sanitize-api-keys"]
-
-resolved: ["block-sudo", "block-rm-rf", "sanitize-api-keys"]  ← 중복 제거된 합집합
-```
-
-**`policyParams`** - 해당 정책의 파라미터를 가장 먼저 정의한 범위가 완전히 우선합니다. 정책 파라미터 내부의 값은 깊은 병합(deep merge)이 수행되지 않습니다.
-
-```text
-project:  block-sudo → { allowPatterns: ["sudo apt-get update"] }
-global:   block-sudo → { allowPatterns: ["sudo systemctl status"] }
-
-resolved: { allowPatterns: ["sudo apt-get update"] }   ← project 우선, global 무시
-```
-
-```text
-project:  (block-sudo 항목 없음)
-local:    (block-sudo 항목 없음)
-global:   block-sudo → { allowPatterns: ["sudo systemctl status"] }
-
-resolved: { allowPatterns: ["sudo systemctl status"] }  ← global까지 전달됨
-```
-
-**`customPoliciesPath`** - 가장 먼저 정의한 범위가 우선합니다.
-
-**`llm`** - 가장 먼저 정의한 범위가 우선합니다.
-
----
-
-## 설정 파일 형식
-
-```json
-{
-  "enabledPolicies": [
-    "block-sudo",
-    "block-rm-rf",
-    "block-push-master",
-    "sanitize-api-keys",
-    "sanitize-jwt",
-    "block-env-files",
-    "block-read-outside-cwd"
-  ],
-  "policyParams": {
-    "block-sudo": {
-      "allowPatterns": ["sudo systemctl status", "sudo journalctl"]
-    },
-    "block-push-master": {
-      "protectedBranches": ["main", "release", "prod"]
-    },
-    "block-rm-rf": {
-      "allowPaths": ["/tmp"]
-    },
-    "block-read-outside-cwd": {
-      "allowPaths": ["/shared/data", "/opt/company"]
-    },
-    "sanitize-api-keys": {
-      "additionalPatterns": [
-        { "regex": "myco_[A-Za-z0-9]{32}", "label": "MyCo API key" }
-      ]
-    },
-    "warn-large-file-write": {
-      "thresholdKb": 512
-    }
-  },
-  "customPoliciesPath": "/home/alice/myproject/my-policies.js"
-}
-```
-
----
-
-## 필드 참조
-
-### `enabledPolicies`
-
-타입: `string[]`
-
-활성화할 정책 이름 목록입니다. 이름은 `failproofai policies`에서 표시하는 정책 식별자와 정확히 일치해야 합니다. 전체 목록은 [기본 제공 정책](/ko/built-in-policies)을 참조하세요.
-
-`enabledPolicies`에 포함되지 않은 정책은 `policyParams`에 항목이 있더라도 비활성 상태입니다.
-
-### `policyParams`
-
-타입: `Record<string, Record<string, unknown>>`
-
-정책별 파라미터 재정의입니다. 외부 키는 정책 이름이고, 내부 키는 정책별로 다릅니다. 각 정책의 사용 가능한 파라미터는 [기본 제공 정책](/ko/built-in-policies)에 문서화되어 있습니다.
-
-파라미터가 있는 정책에 대해 별도로 지정하지 않으면 정책의 기본값이 사용됩니다. `policyParams`를 전혀 설정하지 않은 사용자는 이전 버전과 동일한 동작을 경험합니다.
-
-정책 파라미터 블록 내의 알 수 없는 키는 훅 실행 시 자동으로 무시되지만, `failproofai policies` 실행 시 경고로 표시됩니다.
-
-#### `hint` (공통 옵션)
-
-타입: `string` (선택 사항)
-
-정책이 `deny` 또는 `instruct`를 반환할 때 이유(reason)에 추가되는 메시지입니다. 정책 자체를 수정하지 않고도 Claude에게 실질적인 지침을 제공할 수 있습니다.
-
-기본 제공, 커스텀(`custom/`), 프로젝트 컨벤션(`.failproofai-project/`), 사용자 컨벤션(`.failproofai-user/`) 등 모든 정책 유형에서 사용할 수 있습니다.
-
-```json
-{
-  "policyParams": {
-    "block-force-push": {
-      "hint": "Try creating a fresh branch instead."
-    },
-    "block-sudo": {
-      "allowPatterns": ["sudo apt-get"],
-      "hint": "Use apt-get directly without sudo."
-    },
-    "custom/my-policy": {
-      "hint": "Ask the user for approval first."
-    }
-  }
-}
-```
-
-`block-force-push`가 차단할 때 Claude는 다음을 확인합니다: *"Force-pushing is blocked. Try creating a fresh branch instead."*
-
-문자열이 아닌 값과 빈 문자열은 자동으로 무시됩니다. `hint`가 설정되지 않으면 동작이 변경되지 않습니다(이전 버전과 호환).
-
-### `customPoliciesPath`
-
-타입: `string` (절대 경로)
-
-커스텀 훅 정책이 포함된 JavaScript 파일의 경로입니다. `failproofai policies --install --custom <path>`를 실행하면 자동으로 설정됩니다(저장 전에 절대 경로로 변환됨).
-
-파일은 매 훅 이벤트마다 새로 불러오며, 캐싱이 없습니다. 작성 방법은 [커스텀 정책](/ko/custom-policies)을 참조하세요.
-
-### 컨벤션 기반 정책
-
-명시적인 `customPoliciesPath` 외에도, failproofai는 `.failproofai/policies/` 디렉터리에서 정책 파일을 자동으로 검색하여 불러옵니다:
-
-| 레벨 | 디렉터리 | 범위 |
-|------|----------|------|
-| 프로젝트 | `.failproofai/policies/` | 버전 관리를 통해 팀과 공유 |
-| 사용자 | `~/.failproofai/policies/` | 개인용, 모든 프로젝트에 적용 |
-
-**파일 매칭:** `*policies.{js,mjs,ts}` 패턴과 일치하는 파일만 불러옵니다(예: `security-policies.mjs`, `workflow-policies.js`). 디렉터리 내 다른 파일은 무시됩니다.
-
-**설정 불필요:** 컨벤션 정책은 `policies-config.json`에 별도의 항목이 필요하지 않습니다. 디렉터리에 파일을 추가하기만 하면 다음 훅 이벤트 시 자동으로 반영됩니다.
-
-**합집합 로딩:** 프로젝트와 사용자 컨벤션 디렉터리 모두 검색합니다. 두 레벨에서 일치하는 파일이 모두 로드됩니다(`customPoliciesPath`는 첫 번째 범위 우선 방식을 사용하는 것과 다름).
-
-자세한 내용과 예제는 [커스텀 정책](/ko/custom-policies)을 참조하세요.
-
-### `llm`
-
-타입: `object` (선택 사항)
-
-AI 호출을 수행하는 정책을 위한 LLM 클라이언트 설정입니다. 대부분의 설정에서는 필요하지 않습니다.
-
-```json
-{
-  "llm": {
-    "model": "claude-sonnet-4-6",
-    "apiKey": "sk-ant-..."
-  }
-}
-```
-
----
-
-## CLI에서 설정 관리하기
-
-`policies --install` 및 `policies --uninstall` 명령은 Claude Code의 `settings.json`(훅 진입점)에 기록하며, `policies-config.json`은 직접 관리하는 파일입니다. 두 파일은 별개입니다:
-
-- **`settings.json`** - Claude Code가 각 도구 사용 시 `failproofai --hook <event>`를 호출하도록 지시
-- **`policies-config.json`** - failproofai가 어떤 정책을 어떤 파라미터로 평가할지 지시
-
-`policies-config.json`은 언제든지 직접 편집할 수 있으며, 변경 사항은 재시작 없이 다음 훅 이벤트 시 즉시 적용됩니다.
-
----
-
-## 예시: 팀 기본값이 포함된 프로젝트 수준 설정
-
-`.failproofai/policies-config.json`을 저장소에 커밋합니다:
-
-```json
-{
-  "enabledPolicies": [
-    "block-sudo",
-    "block-rm-rf",
-    "block-push-master",
-    "sanitize-api-keys",
-    "block-env-files"
-  ],
-  "policyParams": {
-    "block-push-master": {
-      "protectedBranches": ["main", "release", "hotfix"]
-    }
-  }
-}
-```
-
-각 개발자는 `.failproofai/policies-config.local.json`(gitignore 처리됨)을 생성하여 팀원에게 영향을 주지 않고 개인 설정을 재정의할 수 있습니다.