Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 7, 2025

CLI help displayed TODO placeholders instead of proper descriptions for the root and check commands.

Changes

Root command (cmd/root.go)

  • Short: "A fast, concurrent broken link checker for websites and sitemaps"
  • Long: Description aligned with README explaining validation of links during development with concurrent checking and color-coded output

Check command (cmd/check.go)

  • Short: "Check links on a URL or sitemap"
  • Long: Description of link validation with status code checks and colored results

All descriptions sourced from existing README to maintain consistency across documentation.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • invalid-domain-that-does-not-exist-12345.com
    • Triggering command: /tmp/go-build1037829153/b204/checker.test -test.testlogfile=/tmp/go-build1037829153/b204/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Remove and fix TODO items in --help</issue_title>
<issue_description>TODO items remain in the cli help.

TODO: Add a longer description here

Usage:
  brokli [flags]
  brokli [command]

Available Commands:
  check       TODO: Add a short description here
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  version     Print the version number of Brokli

Flags:
  -h, --help      help for brokli
  -v, --version   version for brokli

Use "brokli [command] --help" for more information about a command.
```</issue_description>

## Comments on the Issue (you are @copilot in this section)

<comments>
</comments>


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

- Replace TODO in root command with proper short/long descriptions
- Replace TODO in check command with proper short/long descriptions
- All descriptions based on README content
- Tests passing, code formatted

Co-authored-by: EndlessTrax <[email protected]>
Copilot AI changed the title [WIP] Remove and fix TODO items in cli help Remove TODO placeholders from CLI help text Nov 7, 2025
Copilot AI requested a review from EndlessTrax November 7, 2025 15:34
@EndlessTrax EndlessTrax marked this pull request as ready for review November 7, 2025 16:15
@EndlessTrax EndlessTrax changed the title Remove TODO placeholders from CLI help text fix: remove todo placeholders from CLI help text Nov 7, 2025
@EndlessTrax EndlessTrax merged commit fc8f17e into main Nov 7, 2025
6 checks passed
@EndlessTrax EndlessTrax deleted the copilot/remove-fix-help-todo-items branch November 7, 2025 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove and fix TODO items in --help

2 participants