Skip to content

feat: improve help command output#1283

Merged
enocom merged 9 commits intov2from
help-message
Aug 17, 2022
Merged

feat: improve help command output#1283
enocom merged 9 commits intov2from
help-message

Conversation

@enocom
Copy link
Copy Markdown
Member

@enocom enocom commented Jul 29, 2022

No description provided.

@enocom enocom requested a review from a team July 29, 2022 16:40
@enocom
Copy link
Copy Markdown
Member Author

enocom commented Jul 29, 2022

Compare with curl --help all -- lots of short and to the point help information that doesn't wrap on small screens.

We have more to share for these flags, but I've tried to condense help commands to the bare minimum without losing meaning.

Comment thread cmd/root.go Outdated
Comment thread cmd/root.go Outdated
Comment thread cmd/root.go Outdated
Comment thread cmd/root.go Outdated
@enocom enocom requested a review from kurtisvg August 1, 2022 21:04
Comment thread cmd/root.go
Comment thread cmd/root.go Outdated
Comment thread cmd/root.go Outdated
Comment thread cmd/root.go Outdated
Comment thread cmd/root.go
Comment thread cmd/root.go Outdated
Comment thread cmd/root.go Outdated
Comment thread cmd/root.go Outdated
@enocom enocom requested a review from hessjcg August 16, 2022 17:51
@enocom enocom requested a review from jackwotherspoon August 16, 2022 19:45
Comment thread cmd/root.go Outdated
Comment thread cmd/root.go
For example, if your instance connection name is "my-project:us-central1:my-db-server",
starting the proxy will be:

./cloudsql-proxy my-project:us-central1:my-db-server
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

note: cloud-sql-auth-proxy?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We need to make a pass through the entire repo and settle on whatever we're calling this binary. I'll send that as a separate PR.

Comment thread cmd/root.go Outdated
Comment thread cmd/root.go
Co-authored-by: Kurtis Van Gent <[email protected]>
@kurtisvg kurtisvg changed the title docs: improve help command output feat: improve help command output Aug 17, 2022
@enocom enocom merged commit fb16289 into v2 Aug 17, 2022
@enocom enocom deleted the help-message branch August 17, 2022 02:32
enocom added a commit that referenced this pull request Aug 23, 2022
enocom added a commit that referenced this pull request Aug 29, 2022
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.

4 participants