이 페이지는 공개 계약에서 생성하며 설명은 원문(한국어) 그대로 표시합니다.
stly feedback submit#
VoC 피드백 비대화형 제출
- HTTP 요청:
POST /api/feedback - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 예
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--message | string | 예 | VoC 내용, 10000자 이하 |
--source | string | 예 | 작성 주체. 사람은 user, AI Agent는 ai-agent 값: user, ai-agent |
--title | string | 예 | VoC 제목, 200자 이하 |
--type | string | 예 | VoC 유형 값: bug, usability, feature-request, workflow-improvement, documentation, performance, other |
--approved | boolean | 아니요 | AI Agent 제출에 대한 사용자 승인. ai-agent 제출에만 사용 |
--command | string | 아니요 | 문제가 발생한 stly 명령 |
--error-code | string | 아니요 | 응답 오류 code 또는 reason |
--expected-behavior | string | 아니요 | 기대한 동작 |
--expected-effect | string | 아니요 | 기대 효과 |
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: has_duplicate_candidates, id |
--reproduction-steps | string | 아니요 | 재현 절차 |
--suggestion | string | 아니요 | 개선 제안 |
--trigger | string | 아니요 | 문제가 발생한 계기 |
--workaround | string | 아니요 | 찾은 우회 방법 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
동작
- stly 사용 중 막히거나 반복 수동 단계·과도한 호출 등 개선할 점을 실제로 관찰했을 때만 사용자에게 초안을 제안합니다. 매 명령·작업마다 만들지 않으며, 먼저 help·schema로 지원 기능을 몰라서 생긴 문제가 아닌지 확인하고 같은 작업에서 이미 제안한 내용은 다시 권하지 않습니다
- 유형·제목·내용·작성 주체를 옵션으로 지정합니다: --type, --title, --message, --source user|ai-agent. 선택 맥락은 --command·--error-code·--trigger·--reproduction-steps 등
- 전송 전에 비밀정보(토큰·비밀번호·Authorization·Cookie·URL 비밀번호·비밀 키)를 [REDACTED]로 가립니다. 모든 형태를 보장하지 않으므로 --dry-run으로 마스킹된 전송 데이터를 확인합니다
- AI Agent 제출(--source ai-agent)은 사용자 승인(--approved) 또는 사전 opt-in(STLY_FEEDBACK_AGENT_OPT_IN=true)이 있을 때만 전송합니다. 없으면 전송 없이 CLI_APPROVAL_REQUIRED(outcome not_sent)를 반환합니다
- 성공 응답 data.id가 접수 ID입니다. status 201은 새 접수, 200은 같은 키·내용의 재전송입니다
- 결과가 불명확하면(outcome unknown) 같은 명령을 그대로 다시 실행합니다. 같은 내용은 같은 재전송 키를 사용하므로 중복 접수 없이 기존 접수를 확인합니다
예시
stly feedback submit --type bug --title "요약 제목" --message "현상과 기대 동작" --source user