tldr-pages / tldr-pages/tldr-python-client

[Feature Request] Add verbose/debug flag for better troubleshooting

Open
#267 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
749
Forks
117
PR merge metrics
No merged PRs in 30d

Description

I am experiencing issues with tldr when trying to fetch the page for tar. There is no error message other than "Page not found.":

❯ tldr tar
✔ Page not found. Updating cache...
✔ Creating index...
Page not found.

This issue seems to be related to my complex network setup (company laptop with custom certificates, running on WSL). I suspect there might be a networking issue blocking the request, but I have no way of investigating further due to the lack of detailed output or logs. I tried TLDR_ALLOW_INSECURE=1

Suggestion:
Add a --verbose flag to show detailed output of what tldr is doing.
Alternatively, add debug flags to provide more granular logging.
If there is already a debug flag, it would be helpful to mention in in README.

The issue is likely on my side, but without detailed logs, I cannot progress.
Thank you for your assistance!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the tldr command entry point and trace the page-fetch and cache-update flow shown in the report. Determine how verbose or debug output should expose networking failures, then reproduce tldr tar with the reported setup and document or test the resulting diagnostics.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.