Skip to content

techkwon/neis-school-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NEIS School CLI

GitHub release CI ClawHub

한국 학교 검색, 급식 조회, 시간표 조회를 위한 AI-friendly CLI 저장소입니다.

이 저장소의 중심은 CLI입니다. Codex skill과 Claude command는 이 CLI를 호출하는 얇은 어댑터로 둡니다.

Why This Exists

보통 학교 급식/시간표 조회는:

  • 학교 코드와 교육청 코드를 알아야 하고
  • 웹에서 직접 찾아야 하고
  • 에이전트가 다시 쓰기 어려운 비정형 출력으로 끝나는 경우가 많습니다

neis-school-cli는 이 흐름을 바꿉니다.

  • 학교명만으로 검색 가능
  • 사람이 읽기 좋은 텍스트 출력 제공
  • 에이전트가 바로 소비할 수 있는 안정적인 JSON envelope 제공
  • Codex, Claude Code, OpenClaw에서 같은 CLI를 재사용 가능

Public Links

Screenshots

School search JSON:

School search screenshot

Meal lookup:

Meal lookup screenshot

Timetable lookup:

Timetable lookup screenshot

Goals

  • 웹의 NEIS OpenAPI를 안정적으로 다루는 로컬 CLI 제공
  • 사람이 쓰기 쉬운 텍스트 출력과 AI가 쓰기 쉬운 JSON 출력 동시 제공
  • Codex와 Claude에서 같은 CLI를 재사용
  • GitHub에 공개해 repo/path 또는 command 파일 방식으로 배포 가능하게 유지

Quick Install

Codex:

python /Users/you/.codex/skills/.system/skill-installer/scripts/install-skill-from-github.py \
  --repo techkwon/neis-school-cli \
  --path skills/neis-school-cli

Claude Code:

git clone https://github.com/techkwon/neis-school-cli.git
cd neis-school-cli
bash scripts/install-local-integrations.sh

OpenClaw / ClawHub:

clawhub install neis-school-cli

참고:

  • ClawHub는 현재 published skill 라이선스를 플랫폼 기본값인 MIT-0로 표시합니다.
  • 저장소 소스 코드는 루트 LICENSE 기준을 따릅니다.

또는 저장소를 내려받은 뒤:

git clone https://github.com/techkwon/neis-school-cli.git
cd neis-school-cli
bash scripts/install-local-integrations.sh

Repository Shape

neis-school-skill/
├── README.md
├── docs/
│   └── ai/
│       ├── cli-manifest.json
│       └── json-output-example.json
├── integrations/
│   ├── claude/
│   │   └── commands/
│   │       └── sc/
│   │           └── neis-school.md
│   └── openclaw/
│       └── commands/
│           └── sg/
│               └── neis-school.toml
└── skills/
    └── neis-school-cli/
        ├── SKILL.md
        ├── agents/openai.yaml
        ├── scripts/neis_cli.py
        ├── scripts/run-neis-cli.sh
        ├── references/neis-api.md
        └── tests/

Core Commands

학교 검색:

python3 skills/neis-school-cli/scripts/neis_cli.py school search "세종과학예술영재학교"

급식 조회:

python3 skills/neis-school-cli/scripts/neis_cli.py meal --school "늘봄초등학교" --region "세종" --date 2026-03-16

시간표 조회:

python3 skills/neis-school-cli/scripts/neis_cli.py timetable --school "세종과학예술영재학교" --region "세종" --date 2026-03-16 --grade 1 --classroom 1

JSON-First Use

AI 에이전트나 다른 도구가 붙을 때는 --json을 우선 사용합니다.

python3 skills/neis-school-cli/scripts/neis_cli.py school search "세종과학예술영재학교" --json

현재 JSON 응답은 공통 envelope를 사용합니다.

{
  "ok": true,
  "cli": { "name": "neis-school-cli", "version": "0.2.1" },
  "provider": "neis",
  "command": "school.search",
  "endpoint": "schoolInfo",
  "query": { "school_name": "세종과학예술영재학교", "region": null },
  "count": 1,
  "data": {
    "schools": []
  }
}

기계가 읽어야 하는 계약은 cli-manifest.jsonjson-output-example.json에 둡니다.

Share Kit

공유용 문구와 데모 흐름은 docs/launch/social-posts.md에 정리했습니다.

Environment

export NEIS_API_KEY="발급받은키"

일부 공개 조회는 키 없이도 동작할 수 있지만, 일관된 사용을 위해 키 설정을 권장합니다.

Integrations

Codex:

  • 저장소 안의 SKILL.md를 사용
  • GitHub 공개 후 skills/neis-school-cli 경로를 설치 대상으로 사용

Claude:

  • 저장소 안의 neis-school.md를 사용
  • 저장소 안의 Claude skill도 함께 제공
  • 로컬 ~/.claude/skills/neis-school-cli/에 연결하면 /neis-school-cli 형태의 정식 skill로 재사용 가능
  • ~/.claude/commands/sc/ command도 유지해서 /sc:neis-school로 바로 호출 가능

OpenClaw:

  • 저장소 안의 neis-school.toml를 사용
  • 로컬 ~/.gemini/commands/sg/에 연결하면 /sg:neis-school 형태로 재사용 가능
  • 현재 머신에서는 OpenClaw command registry가 ~/.gemini/commands/sg/ 구조로 보이므로 그 위치를 정식 등록 지점으로 사용
  • OpenClaw workspace skill 경로인 ~/.openclaw/skills/neis-school-cli/에도 동일 CLI 기반 skill을 연결

로컬 등록 스크립트:

bash scripts/install-local-integrations.sh

Local Test

python3 -m unittest discover -s skills/neis-school-cli/tests -v
python3 skills/neis-school-cli/scripts/neis_cli.py --help

GitHub Actions CI도 같은 테스트를 실행합니다.

Official Sources

About

AI-friendly CLI for Korean school search, meals, and timetables via the NEIS OpenAPI, with Codex, Claude Code, and OpenClaw integrations.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors