docs: 全コマンドの help content を充実#96
Merged
Merged
Conversation
全 24 コマンドファイルの description と examples を改善: - 各コマンドの description を具体的に（何が返るか、いつ使うか） - thin だった get/delete/list 等に table format や profile-scoped の例を追加 - admin コマンドに破壊的操作の注意書きを追加 - auth/profile に auto-refresh やテナント切り替えの文脈を追加 - catalog/snapshots/rules/models 等の説明を大幅に充実
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughこのPRはCHANGELOG.mdの更新と、24件のCLIコマンド関連ファイルのhelp/description、 Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CHANGELOG.md`:
- Line 11: The Docs entry "全コマンドの help 内容を充実 — description の具体化、examples
の追加（テーブル形式、プロフィルスコープ、ユースケース別の例）、24 ファイル改善" is missing the PR number suffix;
update that line to append the same PR suffix used elsewhere (e.g., "(`#96`)") so
its format matches other entries in CHANGELOG.md and maintains consistency with
the date group.
In `@src/commands/me-policies.ts`:
- Line 175: me-policies コマンドの .description にある "Delete a personal policy — any
API key or OAuth client bound to it loses its access restrictions"
は誤解を招く表現なので、ポリシーが削除された結果「そのポリシーで付与されていたアクセス（権限）を失う」という意味に明確に言い換えてください；具体的には
me-policies コマンドの .description(...) の文字列を「Delete a personal policy — any API key
or OAuth client that relied on it will lose the access it
granted」や日本語なら「個人ポリシーを削除します — そのポリシーで付与されていたアクセス権を該当の API キーや OAuth
クライアントが失います」などの表現に置き換えてください。
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b1658180-81f9-4f10-8cf9-1f32b74de35e
📒 Files selected for processing (24)
CHANGELOG.mdsrc/commands/admin/api-keys.tssrc/commands/admin/oauth-clients.tssrc/commands/admin/policies.tssrc/commands/admin/tenants.tssrc/commands/admin/users.tssrc/commands/attrs.tssrc/commands/auth.tssrc/commands/catalog.tssrc/commands/cli.tssrc/commands/config.tssrc/commands/entities.tssrc/commands/health.tssrc/commands/me-api-keys.tssrc/commands/me-oauth-clients.tssrc/commands/me-policies.tssrc/commands/models.tssrc/commands/profile.tssrc/commands/registrations.tssrc/commands/rules.tssrc/commands/snapshots.tssrc/commands/subscriptions.tssrc/commands/temporal.tssrc/commands/types.ts
複数行の .description() を持つ 29 コマンドに .summary() を追加。 Commander の .summary() が親コマンド一覧で優先されるため、 SUBCOMMANDS セクションが1行ずつきれいに表示されるようになった。 個別コマンドの --help では引き続き詳細な description が表示される。
There was a problem hiding this comment.
♻️ Duplicate comments (1)
src/commands/me-policies.ts (1)
176-176:⚠️ Potential issue | 🟡 Minor削除影響の文言が逆方向に読めるため修正してください。
Line 176 の “loses its access restrictions” は「制限が外れる（権限が広がる）」解釈になり得ます。
admin/policies側と同様に「このポリシーで付与されていたアクセスを失う」意味へ揃えるのが安全です。修正案
- .description("Delete a personal policy — any API key or OAuth client bound to it loses its access restrictions") + .description("Delete a personal policy — any API key or OAuth client bound to it loses the access it granted")🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/commands/me-policies.ts` at line 176, The description string for the "delete personal policy" command is worded poorly and can be read as removing restrictions instead of revoking access; update the .description(...) call in src/commands/me-policies.ts (the builder/command where the Delete personal policy description is set) to mirror admin/policies wording so it clearly states that any API key or OAuth client bound to the policy will lose the access granted by this policy (e.g., replace "loses its access restrictions" with "will lose the access granted by this policy").
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@src/commands/me-policies.ts`:
- Line 176: The description string for the "delete personal policy" command is
worded poorly and can be read as removing restrictions instead of revoking
access; update the .description(...) call in src/commands/me-policies.ts (the
builder/command where the Delete personal policy description is set) to mirror
admin/policies wording so it clearly states that any API key or OAuth client
bound to the policy will lose the access granted by this policy (e.g., replace
"loses its access restrictions" with "will lose the access granted by this
policy").
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d4f6794d-f0be-4f26-b740-1bfac27d5b2f
📒 Files selected for processing (13)
src/commands/admin/oauth-clients.tssrc/commands/admin/policies.tssrc/commands/admin/tenants.tssrc/commands/admin/users.tssrc/commands/attrs.tssrc/commands/batch.tssrc/commands/entities.tssrc/commands/me-policies.tssrc/commands/models.tssrc/commands/registrations.tssrc/commands/rules.tssrc/commands/subscriptions.tssrc/commands/temporal.ts
✅ Files skipped from review due to trivial changes (8)
- src/commands/batch.ts
- src/commands/temporal.ts
- src/commands/entities.ts
- src/commands/attrs.ts
- src/commands/admin/oauth-clients.ts
- src/commands/rules.ts
- src/commands/admin/tenants.ts
- src/commands/registrations.ts
🚧 Files skipped from review as they are similar to previous changes (3)
- src/commands/admin/policies.ts
- src/commands/models.ts
- src/commands/subscriptions.ts
- CHANGELOG.md: Docs エントリに (#96) サフィックス追加 - me-policies.ts: "loses its access restrictions" → "loses access granted by this policy" に修正（セキュリティ上の誤解を防止）
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
全コマンドの help (description / examples) を充実させた。ユーザーやテナント管理者が
--helpだけで操作方法を理解できるレベルに引き上げ。改善内容
--format table、--profileスコープ、ユースケース別の例を網羅的に追加対象ファイル (24 files)
Test plan
npm run lint— パスnpm run typecheck— パスnpm test— 684/684 パス--help出力を目視確認Summary by CodeRabbit
--format tableを含む）を追加しました。