Skip to content

fix: backtick http-proxy example URL to prevent broken doc links #857

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.

Sign up for GitHub

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

Merged
dangrondahl merged 1 commit into from
May 4, 2026
+1 −1
Merged

fix: backtick http-proxy example URL to prevent broken doc links #857

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion cmd/kosli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The ^.kosli_ignore^ will be treated as part of the artifact like any other file,
artifactDisplayName = "[optional] Artifact display name, if different from file, image or directory name."
orgFlag = "The Kosli organization."
hostFlag = "[defaulted] The Kosli endpoint."
httpProxyFlag = "[optional] The HTTP proxy URL including protocol and port number. e.g. 'http://proxy-server-ip:proxy-port'"
httpProxyFlag = "[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`"
Copy link
Copy Markdown
Contributor

@mbevc1 mbevc1 May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are other URL's not using backtics either..is that a problem and how does it work in console?

Copy link
Copy Markdown
Contributor Author

@dangrondahl dangrondahl May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mbevc1
Cobra just strips backticks, so

./kosli fingerprint --help 2>&1 | grep "http-proxy"
      --http-proxy http://proxy-server-ip:proxy-port   [optional] The HTTP proxy URL including protocol and port number. e.g. http://proxy-server-ip:proxy-port

Copy link
Copy Markdown
Contributor Author

@dangrondahl dangrondahl May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I was just focused on this particular URL as this shows up in mint broken-links

dryRunFlag = "[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors."
maxAPIRetryFlag = "[defaulted] How many times should API calls be retried when the API host is not reachable."
configFileFlag = "[optional] The Kosli config file path."
Expand Down
Loading