Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions crates/xgen-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1442,7 +1442,7 @@ impl ModelCliError {
match self {
Self::Check(error) => match error {
ModelCheckError::AuthenticationRejected | ModelCheckError::InvalidCredential => {
"Run xgen model setup to enter a valid API key locally; never paste keys into chat."
"For a saved key, run xgen model logout PROFILE, then xgen model setup --name PROFILE to enter a new key locally. Check xgen model list for profile names; never paste keys into chat."
}
ModelCheckError::ModelNotAdvertised | ModelCheckError::InvalidModel => {
"Run xgen model setup and select an exact model ID advertised by the endpoint."
Expand Down Expand Up @@ -1476,7 +1476,7 @@ impl ModelCliError {
}
},
Self::Profile(ModelProfileError::CredentialNotFound) => {
"The saved API key is unavailable. Run xgen model setup to enter it again locally, or inject XGEN_OPENAI_API_KEY for this process."
"The saved API key is unavailable. Check xgen model list, then run xgen model setup --name PROFILE to enter it again locally, or inject XGEN_OPENAI_API_KEY for this process."
}
Self::Profile(ModelProfileError::CredentialStoreUnavailable) => {
"Unlock the OS credential store, or inject XGEN_OPENAI_API_KEY and omit --store-token. No plaintext key file is used."
Expand Down
3 changes: 2 additions & 1 deletion docs/adr/0088-first-use-preview-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Provider/model 메뉴는 잘못된 번호를 같은 메뉴에서 다시 받는

Model setup/check/configuration 오류는 기존 reason·exit code와 정적 `recovery:` 문장을 함께 출력한다.
인증 재설정, exact model ID, API root, response format·parameter style, provider 가용성·출력/시간 예산을
안내한다. Provider 응답 원문·실제 endpoint·key를 오류에 추가하지 않는다. 기존 profile의 옵션은 자동
안내한다. 폐기된 저장 key는 `model logout PROFILE` 뒤 같은 profile을 재설정하도록 안내하며
재설정만으로 기존 key가 교체된다고 가정하지 않는다. Provider 응답 원문·실제 endpoint·key를 오류에 추가하지 않는다. 기존 profile의 옵션은 자동
변경하지 않고 OpenAI profile 갱신 예시를 문서에 제공한다.

README 첫 화면은 일반 설치·모델 연결·작은 작업·복구 순서로 정리하고 현재 preset/TUI 동작과 맞춘다.
Expand Down
3 changes: 2 additions & 1 deletion docs/development/model-onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ file/log regression을 담당한다. 설계와 실패 순서는 [ADR-0032](../ad
endpoint는 진단에 추가하지 않는다. 제공자·model 번호를 잘못 입력하면 같은 메뉴에서 다시 고를 수 있고,
`q`나 EOF는 설정을 중단한다. Compatibility probe가 실패하면 기존 profile을 바꾸지 않는다.

- `credential_not_found`: `xgen model setup`으로 key를 로컬에서 다시 입력한다. Headless는 secret manager에서 `XGEN_OPENAI_API_KEY`를 process에 주입할 수 있다.
- `credential_not_found`: `xgen model list`에서 profile 이름을 확인하고 `xgen model setup --name PROFILE`로 key를 로컬에서 다시 입력한다. Headless는 secret manager에서 `XGEN_OPENAI_API_KEY`를 process에 주입할 수 있다.
- `authentication_rejected`: 저장된 key가 폐기됐다면 `xgen model logout PROFILE`로 지운 뒤 `xgen model setup --name PROFILE`로 다시 입력한다. 기존 key가 남아 있으면 setup이 재사용한다. Environment key가 있으면 그 값이 우선이므로 로컬에서 갱신하거나 해제한다.
- `model_not_advertised`: `xgen model setup`에서 목록에 있는 정확한 model ID를 고른다.
- `request_rejected` / `chat_completions_incompatible`: response format·parameter style과 응답의 exact model ID를 확인한다. Alias가 다른 snapshot ID를 반환하면 그 snapshot을 목록에서 선택한다.
- `provider_output_truncated`: `xgen model setup --max-output-tokens 4096`처럼 출력 예산을 조정하고 compatibility를 다시 검사한다.
Expand Down