Skip to main content

Clear Korean

AI가 한국어로 짧고 명확하게 답하도록 만드는 지침 모음입니다. 자연스러운 한국어뿐 아니라 답변 길이, 사실과 추측의 구분, 사용자의 지식 수준에 맞춘 설명을 함께 다룹니다.

제공 내용

용도와 말투를 조합한 네 가지 완성본을 제공합니다.

대상 말투 파일
개발자용 간결한 평서형 presets/developer/plain/
개발자용 정중한 존댓말 presets/developer/polite/
일반 사용자용 간결한 평서형 presets/general/plain/
일반 사용자용 정중한 존댓말 presets/general/polite/

각 디렉터리에는 내용이 같은 세 파일이 있습니다. 사용하는 환경에 맞는 이름을 고르면 됩니다.

  • AGENTS.md: Codex 전역 또는 프로젝트 지침
  • CLAUDE.md: Claude Code 전역 또는 프로젝트 지침
  • INSTRUCTIONS.md: ChatGPT, Claude 앱, Gemini 등에서 복사해 쓸 수 있는 일반 지침

기존 presets/developer/*.mdpresets/general/*.md 경로는 평서형 호환 경로입니다.

배포 방식

초기 버전은 GitHub 저장소, 독립된 Markdown 파일과 CLI를 정식 배포 경로로 사용합니다.

  • Markdown: 파일을 검토한 뒤 직접 복사하려는 사용자에게 적합합니다.
  • CLI: 지침 출력, 자동 삽입·갱신, 상태 확인과 제거를 제공합니다.
  • 웹사이트: 지침 비교, 미리보기와 클립보드 복사 UI가 필요할 때 추가합니다. 브라우저는 로컬 설정 파일을 직접 수정할 수 없으므로 자동 설치 수단으로 사용하지 않습니다.
  • GitHub 주소: https://github.com/x-mesh/clear-korean을 기준 주소로 사용합니다.

설치

CLI로 설치

GitHub에서 바로 실행할 수 있습니다.

uvx --from git+https://github.com/x-mesh/clear-korean clear-korean --help

PyPI에 clear-korean 패키지를 배포한 뒤에는 더 짧게 실행할 수 있습니다. 인자 없이 실행하면 대화형 설정이 열립니다.

uvx clear-korean

uvx clear-korean setup으로도 같은 화면을 열 수 있습니다. 시작 화면에는 CLI 버전이 표시됩니다. 단계별 화면에서 위·아래 방향키 또는 j/k로 이동하고 Enter로 선택합니다. 3단계에서 파일 설치와 지침 출력 중 하나를 고릅니다. 출력할 때는 대상과 범위를 묻지 않습니다. 설치할 때는 마지막 확인 화면에서 실제 대상 파일을 검토하거나 선택을 다시 시작할 수 있습니다. Esc나 Ctrl+C로 취소합니다.

대화형 설정에서 용도, 말투, 적용 대상, 범위와 실행 방법을 차례로 고릅니다. 터미널이 없는 자동화 환경에서는 아래 하위 명령을 사용합니다.

개발자용 지침을 Codex와 Claude Code의 사용자 전역 파일에 함께 설치합니다.

uvx clear-korean install --agent all --scope user --preset developer --tone plain

현재 프로젝트에만 설치하려면 프로젝트 루트에서 실행합니다.

uvx clear-korean install --agent all --scope project --preset developer --tone polite

CLI는 기존 파일 전체를 덮어쓰지 않습니다. Clear Korean 관리 마커 사이에만 지침을 삽입하거나 갱신하며, 파일을 변경하기 전에 같은 디렉터리에 *.clear-korean.<timestamp>.bak 백업을 만듭니다. 심볼릭 링크와 손상된 관리 마커는 자동 수정하지 않습니다.

쓰기 전에 변경 내용을 확인하려면 --dry-run을 사용합니다.

uvx clear-korean install --agent codex --scope project --preset general --dry-run

상태 확인과 제거:

uvx clear-korean status --agent all --scope user
uvx clear-korean remove --agent all --scope user

전체 명령과 파일 안전 정책은 CLI 문서에 정리되어 있습니다.

AGENTS.override.md가 있으면 Codex가 AGENTS.md보다 override 파일을 우선합니다. CLI는 이 상황을 경고하지만 override 파일을 자동 변경하지 않습니다.

출력만 받기

파일을 자동 수정하지 않고 지침만 표준 출력으로 받을 수 있습니다.

uvx clear-korean print --preset developer --tone plain
uvx clear-korean print --preset general --tone polite

출력을 검토한 뒤 직접 붙여넣거나 파일로 저장할 수 있습니다.

uvx clear-korean print --preset developer > /tmp/clear-korean.md

Markdown을 직접 설치

기존 지침 파일이 있다면 먼저 내용을 확인합니다. Clear Korean 파일로 바로 덮어쓰지 말고, 충돌하는 규칙을 정리한 뒤 병합합니다.

Codex

개발자용 완성본인 presets/developer/AGENTS.md을 다음 위치 중 하나에 둡니다.

  • 모든 프로젝트: ~/.codex/AGENTS.md
  • 한 프로젝트: 저장소 루트의 AGENTS.md

일반 사용자용이 필요하면 presets/general/AGENTS.md를 사용합니다. Codex는 새 세션을 시작할 때 지침을 다시 읽습니다.

Claude Code

개발자용 완성본인 presets/developer/CLAUDE.md을 다음 위치 중 하나에 둡니다.

  • 모든 프로젝트: ~/.claude/CLAUDE.md
  • 한 프로젝트: 저장소 루트의 CLAUDE.md

일반 사용자용이 필요하면 presets/general/CLAUDE.md를 사용합니다. 새 세션을 시작한 뒤 /context에서 파일이 로드됐는지 확인할 수 있습니다.

일반 AI 환경

presets/general/INSTRUCTIONS.md의 본문을 개인별 지침이나 프로젝트 지침에 복사합니다. 코딩 작업이 중심이면 presets/developer/INSTRUCTIONS.md를 사용합니다.

설계 원칙

  • 결론이나 작업 결과를 먼저 제시합니다.
  • 간결성을 이유로 의미를 생략하지 않고, 명확성을 이유로 불필요하게 길게 쓰지 않습니다.
  • 기본 문체는 존댓말이 아닌 간결한 평서형입니다. 필요한 상황에서는 사용자의 문체 요구를 우선합니다.
  • 사용자가 이미 아는 기술 용어를 반복해서 정의하지 않습니다.
  • 쉬운 말과 예시는 정확성을 해치지 않는 범위에서만 사용합니다.
  • 확인한 사실과 추측을 구분합니다.

개발

instructions/가 정본입니다. presets/의 완성본은 직접 수정하지 않습니다.

./scripts/build.sh
./scripts/check.sh
uvx --from . clear-korean --help

scripts/check.sh는 배포 파일 동기화, 파일 크기와 CLI 단위 테스트를 검사합니다. 행동 테스트 사례는 tests/cases.tsv에 있습니다. 실행 방법과 검증 기록은 tests/README.md에서 관리합니다. 모델 실행은 비용과 환경 차이가 있으므로 기본 검사에 포함하지 않습니다.

12개 한국어 문체의 적용 전후 비교 결과는 docs/STYLE_EVALUATION.md에 있습니다. 지침 후보를 26개 고정 문체와 기준 답안으로 채점하고 회귀를 검사하는 방법은 docs/BENCHMARK.md에 정리했습니다. ai-mesh 설정만 유지하며 Codex를 격리 실행하는 전역 명령은 docs/CODEX_ISOLATED.md에서 설명합니다.

참고한 공식 문서

Download files

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

Source Distribution

clear_korean-0.2.4.tar.gz (68.4 kB view details)

Uploaded Source

Built Distribution

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

clear_korean-0.2.4-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file clear_korean-0.2.4.tar.gz.

File metadata

  • Download URL: clear_korean-0.2.4.tar.gz
  • Upload date:
  • Size: 68.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for clear_korean-0.2.4.tar.gz
Algorithm Hash digest
SHA256 0b75a8d0b41c6f1cc2ca4f0ce70b3b38876b9ba450827f09f928515f134b21c6
MD5 9899d073ea35bdbbd90b68df8c83af00
BLAKE2b-256 2ace7190b6035b2ee30a71d5b4e5745ec5a4cf4d6b39307ce4ae063c84bbdf29

See more details on using hashes here.

File details

Details for the file clear_korean-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: clear_korean-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 28.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for clear_korean-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6c3fcd5cd4e5d4b231f40ed4e15f639f2c56ee96868672665ed821e46aafc14b
MD5 aa252c72a32464cf5b509ff1e5b5b16a
BLAKE2b-256 78228315b29d53fca6daa71862263c51869895e9c173df353b1e7654660f0fab

See more details on using hashes here.

Supported by

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