Skip to content

feat: /help 슬래시 커맨드 추가 및 사용자 가이드 작성#247

Merged
seyoung4503 merged 2 commits into
CausalInferenceLab:masterfrom
thrcle:feat/help-command
Jul 19, 2026
Merged

feat: /help 슬래시 커맨드 추가 및 사용자 가이드 작성#247
seyoung4503 merged 2 commits into
CausalInferenceLab:masterfrom
thrcle:feat/help-command

Conversation

@thrcle

@thrcle thrcle commented Jul 19, 2026

Copy link
Copy Markdown
Collaborator

📝 요약

처음 사용하는 유저가 Discord에서 바로 사용법을 확인할 수 있도록 /help 커맨드와 가이드 문서를 추가합니다.

변경 내용

/help 슬래시 커맨드

Discord에서 /help를 입력하면 주요 커맨드와 사용 플로우를 바로 확인할 수 있습니다.

Lang2SQL 사용 가이드

📊 질문하기
봇을 멘션하거나 채널에서 자연어로 질문하세요.
> @Lang2SQL 이번 달 매출 상위 고객 10명 알려줘

🗄️ DB 연결 (관리자)
/setup — 안내에 따라 DB 접속 정보 입력
...

docs/USAGE.md

단계별 온보딩 가이드입니다. DB 연결 → 용어 등록 → 질문하기 순서로 전체 플로우를 설명합니다.

PR Checklist

  • 변경 사항에 대한 테스트 또는 검증 완료 (159 passed)
  • 로컬에서 정상 동작 확인
  • 관련 문서 업데이트 완료

thrcle and others added 2 commits July 19, 2026 15:20
- /help: 커맨드 목록과 사용 플로우를 Discord에서 바로 확인 가능
- docs/USAGE.md: 처음 사용하는 유저를 위한 단계별 가이드

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@seyoung4503

Copy link
Copy Markdown
Collaborator

머지 가능합니다. 테스트 159개 통과.

커맨드 배선 정상입니다 — description 있고, 도움말이 637자라 디스코드 2000자 제한에 안 걸립니다. 문서에 적힌 10개 커맨드가 전부 실제로 있고 파라미터 이름·필수여부도 맞습니다. uv.lock +279는 PyYAML과 mypy 반영이라 예상 밖 의존성 없습니다.

문서 두 곳만 고쳐주시면 좋겠습니다.

1. docs/USAGE.md:104ref:파일명 안내는 빼는 게 좋겠습니다

| /ingest ref:파일명 | 서버 파일에서 용어 후보 추출 |

file_source.py:22open(ref)에 경로 검증이 없어서, 아무 멤버나 /ingest ref:.envref:/etc/passwd 를 실행하면 파일 내용이 공개 채널에 올라갑니다.

버그 자체는 이전부터 있던 거라 이 PR 범위는 아닙니다. 다만 /help 텍스트(commands.py:277)는 content: 만 안내하는데 USAGE.md만 ref: 를 노출하고 있어서, 이 줄만 빼면 문서가 발견 경로가 되는 건 막을 수 있습니다.

2. /setup 이 관리자 전용이라고 적혀 있는데 실제로는 아닙니다

  • USAGE.md:29 — "관리자 권한이 필요합니다"
  • USAGE.md:101 — "/setup | DB 연결 마법사 (관리자)"
  • commands.py:274 — "🗄️ DB 연결 (관리자)"

bot.py:135-151setup·connect 등록부에 권한 체크가 없습니다. is_admin은 guild 레이어 용어 쓰기에만 쓰이고 있습니다 (semantic_federation.py:39, org_setup.py:125, confirm_ingest.py:81).

지금 상태로는 아무 멤버나 /connect dsn:... 으로 DB 연결을 덮어쓸 수 있습니다. 문구를 지우시거나 실제 체크를 넣으시면 될 것 같은데, 없는 통제를 있다고 적어두면 오히려 안심하고 쓰게 될 것 같아 짚습니다.

사소한 것

  • /help 가 USAGE.md 커맨드 표(:99-113)에 빠져 있습니다
  • commands.py:272 "채널에서 자연어로 질문하세요" — 실제로는 멘션이나 스레드가 필요합니다 (bot.py:290-294). 바로 아래 예시가 멘션이라 오해 소지는 적습니다

@seyoung4503 seyoung4503 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 좋습니다!! 다만, 말씀드렸던 부분은 후속 pr에서 처리해주시면 감사하겠습니다!!

@seyoung4503
seyoung4503 merged commit adf1d9e into CausalInferenceLab:master Jul 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants