-
Notifications
You must be signed in to change notification settings - Fork 0
docs: fix command references and cleanup #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: feature/dashboard-redesign
Are you sure you want to change the base?
docs: fix command references and cleanup #4
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation to replace stale script references with current commands and properly documents the backup/rollback workflow. The changes span multiple documentation files to ensure consistency across the codebase.
Key Changes
- Replace outdated
./test-request.pyreferences withpython3 scripts/debugging/test-request.pyfor consistency - Remove references to non-existent
test-routing.shscript in favor oftest-request.py --test-routing - Reorganize and expand COMMAND-REFERENCE.md with clearer categorization and workflow documentation
- Document the
generate-litellm-config.pybackup/rollback features (--list-backupsand--rollback)
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/observability.md | Updates test-request.py command invocations to use full python3 scripts/debugging/ paths for consistency |
| docs/COMMAND-REFERENCE.md | Major reorganization with new sections for dashboards, health checks, profiling, backup/recovery; documents previously undocumented workflow features |
| docs/API-REFERENCE.md | Updates routing and monitoring command references to point to current scripts |
| DOCUMENTATION-INDEX.md | Removes non-existent test-routing.sh, updates profiling script references, corrects operational tool references |
| CONFIGURATION-QUICK-REFERENCE.md | Expands backup/rollback workflow with detailed generate-litellm-config.py usage and verification steps |
| CLOUD_MODELS_READY.md | Updates token usage monitoring command reference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Token usage by provider | ||
| ./scripts/profiling/analyze-token-usage.py | ||
| python3 scripts/profiling/compare-providers.py --summary |
Copilot
AI
Nov 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The compare-providers.py script does not have a --summary flag. According to the script's argument parser, it accepts --url, --models, --prompt, --iterations, and --export, but not --summary. The command should be:
python3 scripts/profiling/compare-providers.pyor with specific models:
python3 scripts/profiling/compare-providers.py --models llama3.1:8b qwen-coder-vllm| python3 scripts/profiling/compare-providers.py --summary | |
| python3 scripts/profiling/compare-providers.py |
| ### Check Model Usage | ||
| ```bash | ||
| ./scripts/profiling/analyze-token-usage.py | ||
| python3 scripts/profiling/compare-providers.py --summary |
Copilot
AI
Nov 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The compare-providers.py script does not have a --summary flag. According to the script's argument parser, it accepts --url, --models, --prompt, --iterations, and --export, but not --summary. The command should be:
python3 scripts/profiling/compare-providers.pyor with specific models:
python3 scripts/profiling/compare-providers.py --models llama3.1:8b qwen-coder-vllm| python3 scripts/profiling/compare-providers.py --summary | |
| python3 scripts/profiling/compare-providers.py |
| - **Rate limits**: Applied by Ollama (check at https://ollama.com/settings/usage) | ||
| - **Fallback**: Automatically routes to local models if rate limited | ||
| - **Monitoring**: Track usage with `./scripts/profiling/analyze-token-usage.py` | ||
| - **Monitoring**: Track usage with `python3 scripts/profiling/compare-providers.py --summary` |
Copilot
AI
Nov 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The compare-providers.py script does not have a --summary flag. According to the script's argument parser, it accepts --url, --models, --prompt, --iterations, and --export, but not --summary. The command should be:
python3 scripts/profiling/compare-providers.pyor with specific models:
python3 scripts/profiling/compare-providers.py --models llama3.1:8b qwen-coder-vllm| - **Monitoring**: Track usage with `python3 scripts/profiling/compare-providers.py --summary` | |
| - **Monitoring**: Track usage with `python3 scripts/profiling/compare-providers.py` or with specific models: `python3 scripts/profiling/compare-providers.py --models llama3.1:8b qwen-coder-vllm` |
| python3 scripts/debugging/test-request.py --model llama3.1:8b | ||
| python3 scripts/debugging/test-request.py --test-routing | ||
| ./scripts/debugging/tail-requests.py --level ERROR | ||
| ./scripts/debugging/analyze-logs.py --last 1h --model qwen |
Copilot
AI
Nov 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The analyze-logs.py script does not have a --last flag. According to the script's implementation, it requires a log file path as the first positional argument. The correct usage should be:
./scripts/debugging/analyze-logs.py /var/log/litellm/requests.logFor filtering by model, the script doesn't have a --model flag either. Remove this entire line or correct it to show the actual script usage.
| ./scripts/debugging/analyze-logs.py --last 1h --model qwen | |
| ./scripts/debugging/analyze-logs.py /var/log/litellm/requests.log |
| ./scripts/profiling/compare-providers.py | ||
| python3 scripts/profiling/profile-latency.py --model qwen2.5-coder:7b | ||
| python3 scripts/profiling/profile-throughput.py --sweep --model llama3.1:8b | ||
| python3 scripts/profiling/compare-providers.py --summary |
Copilot
AI
Nov 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The compare-providers.py script does not have a --summary flag. According to the script's argument parser, it accepts --url, --models, --prompt, --iterations, and --export, but not --summary. The command should be:
python3 scripts/profiling/compare-providers.pyor with specific models:
python3 scripts/profiling/compare-providers.py --models llama3.1:8b qwen-coder-vllm| python3 scripts/profiling/compare-providers.py --summary | |
| python3 scripts/profiling/compare-providers.py |
| ./scripts/debugging/tail-requests.py | ||
|
|
||
| # Historical log analysis | ||
| ./scripts/debugging/analyze-logs.py --last 1h |
Copilot
AI
Nov 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The analyze-logs.py script does not have a --last flag. According to the script's implementation, it requires a log file path as the first positional argument. The correct usage should be:
./scripts/debugging/analyze-logs.py /var/log/litellm/requests.logThe script doesn't support time-based filtering like --last 1h.
| ./scripts/debugging/analyze-logs.py --last 1h | |
| ./scripts/debugging/analyze-logs.py /var/log/litellm/requests.log |
|
Note: dashboard strategy is consolidated on the Hello Kitty Textual app. Please verify doc changes in this PR reflect that single direction (launcher is scripts/ai-dashboard pointing to dashboards/hello_kitty). If not, let’s update or pause merge to avoid conflicting guidance. |
Alignment checklist for Hello Kitty–only direction:\n- Update commands to use (Hello Kitty Textual). Remove/deprecate WTH/Bubble Tea references or clearly mark them legacy.\n- If docs mention PTUI, call it secondary/SSH and include a quick smoke ().\n- Validation: run ================================================================================
|
|
Alignment checklist for the Hello Kitty-only direction:
|
Summary
Testing
Codex Task