Skip to content

[fix] Use lowercase for positional argument placeholders#361

Merged
EthanHeilman merged 9 commits into
openpubkey:mainfrom
t38miwa:fix-argument-placeholders
Oct 9, 2025
Merged

[fix] Use lowercase for positional argument placeholders#361
EthanHeilman merged 9 commits into
openpubkey:mainfrom
t38miwa:fix-argument-placeholders

Conversation

@t38miwa
Copy link
Copy Markdown
Contributor

@t38miwa t38miwa commented Oct 8, 2025

issue number: #352

Summary

Changed all positional argument placeholders from uppercase to lowercase to maintain
consistency with standard CLI tools like git and ssh.

Changes

  • main.go: Changed placeholders in add, readhome, and verify commands
    • add: <PRINCIPAL> <EMAIL|SUB|GROUP> <ISSUER> → <principal> <email|sub|group> <issuer>
    • readhome: <PRINCIPAL> → <principal>
    • verify: <PRINCIPAL> <CERT> <KEY_TYPE> → <principal> <cert> <key_type>
  • README.md: Changed placeholders in documentation examples
  • docs/config.md: Changed placeholders in add command example
  • scripts/installing.md: Changed placeholders in installation instructions

Test Plan

  • Built opkssh successfully
  • Verified help output shows lowercase placeholders
スクリーンショット 2025-10-08 午後11 10 04
  • All unit tests pass (go test ./...)
スクリーンショット 2025-10-08 午後11 09 29
  • Code formatted correctly (go fmt ./...)
  • No issues from go vet

t38miwa added 4 commits October 8, 2025 22:41
@t38miwa
docs: Use lowercase for positional argument placeholders in
e00956f 
  scripts/installing.md

  Changed {USER} {EMAIL} {ISSUER} to {user} {email} {issuer} to maintain consistency with
  other CLI tools like git and ssh.

  Fixes openpubkey#352

Signed-off-by: t38miwa <t38miwa@gmail.com>
@t38miwa
docs: Use lowercase for positional argument placeholders in
a7604b0 
  docs/config.md

  Changed {USER} {EMAIL|SUB|CLAIM} {ISSUER} to {user} {email|sub|claim} {issuer} to
  maintain consistency with other CLI tools like git and ssh.

  Fixes openpubkey#352

Signed-off-by: t38miwa <t38miwa@gmail.com>
@t38miwa
docs: Use lowercase for positional argument placeholders in README.md
75654ab 
  Changed {USER} {EMAIL/SUB/GROUP} {ISSUER} to {user} {email/sub/group} {issuer} and
  {ISSUER},{CLIENT_ID},{CLIENT_SECRET},{SCOPES} to
  {issuer},{client_id},{client_secret},{scopes} to maintain consistency with other CLI
  tools like git and ssh.

  Fixes openpubkey#352

Signed-off-by: t38miwa <t38miwa@gmail.com>
@t38miwa
Use lowercase for positional argument placeholders in main.go
be8b32e 
  Changed placeholder names in command definitions to lowercase:
  - add: <PRINCIPAL> <EMAIL|SUB|GROUP> <ISSUER> -> <principal> <email|sub|group> <issuer>
  - readhome: <PRINCIPAL> -> <principal>
  - verify: <PRINCIPAL> <CERT> <KEY_TYPE> -> <principal> <cert> <key_type>

  This maintains consistency with other CLI tools like git and ssh.

  Fixes openpubkey#352

Signed-off-by: t38miwa <t38miwa@gmail.com>
@t38miwa t38miwa mentioned this pull request Oct 8, 2025
Closed
2 tasks
EthanHeilman
EthanHeilman requested changes Oct 8, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@EthanHeilman EthanHeilman left a comment

Choose a reason for hiding this comment

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

Looks good, added one additional change request

Comment thread docs/config.md Outdated
@t38miwa
docs: Use angle brackets for positional argument placeholders │
15c8fb8 
│                                                                                                                                                       │
│   Changed curly braces to angle brackets for consistency:                                                                                             │
│   - {user} {email} {issuer} → <user> <email> <issuer>                                                                                                 │
│   - {user} {email|sub|claim} {issuer} → <user> <email|sub|claim> <issuer>                                                                             │
│   - {user} {email/sub/group} {issuer} → <user> <email/sub/group> <issuer>                                                                             │
│   - {issuer},{client_id} → <issuer>,<client_id>                                                                                                       │
│   - {issuer},{client_id},{client_secret},{scopes} → <issuer>,<client_id>,<client_secret>,<scopes>                                                     │
│                                                                                                                                                       │
│   This follows the common convention used by other CLI tools where                                                                                    │
│   angle brackets indicate user-supplied values.                                                                                                       │
│                                                                                                                                                       │
│   Fixes openpubkey#352
@t38miwa
Copy link
Copy Markdown
Contributor Author

t38miwa commented Oct 9, 2025

seems like some test failed,,, I'll fix it

t38miwa added 2 commits October 9, 2025 14:35
@t38miwa
chore: Trigger CI workflow rerun
b159150 
  Add comment to trigger workflow execution again to verify if
  the CentOS Docker image issue is intermittent or persistent.

  Related to openpubkey#352

Signed-off-by: t38miwa <t38miwa@gmail.com>
@t38miwa
chore: fixed Readme.md which was changed to rerun workflow
a8201a6 
  Add comment to trigger workflow execution again to verify if
  the CentOS Docker image issue is intermittent or persistent.

  Related to openpubkey#352

Signed-off-by: t38miwa <t38miwa@gmail.com>
@t38miwa
Copy link
Copy Markdown
Contributor Author

t38miwa commented Oct 9, 2025 •
edited
Loading

@EthanHeilman #364 maybe there is problems in integration test progress, which is not related to change of this PR.

EthanHeilman
EthanHeilman approved these changes Oct 9, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@EthanHeilman EthanHeilman left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for PR this! Feel free to open any issues or PRs that you want to work on

@EthanHeilman EthanHeilman changed the title fix: Use lowercase for positional argument placeholders [fix] Use lowercase for positional argument placeholders Oct 9, 2025
@EthanHeilman EthanHeilman merged commit bb75502 into openpubkey:main Oct 9, 2025
16 checks passed
@t38miwa
Copy link
Copy Markdown
Contributor Author

t38miwa commented Oct 10, 2025

thanks for ur help ethan

renovate Bot added a commit to sdwilsh/ansible-playbooks that referenced this pull request Jan 5, 2026
@renovate
chore(deps): update dependency openpubkey/opkssh to v0.11.0
e5d091e 
##### [\`v0.11.0\`](https://github.com/openpubkey/opkssh/releases/tag/v0.11.0)

##### 🚀 Features

- Add support for custom group claims [@mvanderlee](https://github.com/mvanderlee) ([#133](openpubkey/opkssh#133))
- feat: Flag to print SSH cert and private key rather than FS [@EthanHeilman](https://github.com/EthanHeilman) ([#437](openpubkey/opkssh#437))
- feat: Process extra arguments to the verify command [@justincmoy](https://github.com/justincmoy) ([#436](openpubkey/opkssh#436))
- Add warning message when email claim is missing from ID token @[copilot-swe-agent\[bot\]](https://github.com/apps/copilot-swe-agent) ([#374](openpubkey/opkssh#374))
- \[feat] Add new "inspect" subcommand [@stmcginnis](https://github.com/stmcginnis) ([#349](openpubkey/opkssh#349))
- Add CLI reference documentation [@stmcginnis](https://github.com/stmcginnis) ([#365](openpubkey/opkssh#365))
- Include signature JSON in `inspect` output [@stmcginnis](https://github.com/stmcginnis) ([#358](openpubkey/opkssh#358))
- - docs: Add Amazon Cognito as tested provider [@Foorack](https://github.com/Foorack) ([#414](openpubkey/opkssh#414))
- docs: Add documentation for opkssh and sssd integration [@vigneshmanick](https://github.com/vigneshmanick) ([#409](openpubkey/opkssh#409))
- Added SELinux support for sudo logging [@descensus](https://github.com/descensus) ([#376](openpubkey/opkssh#376))
- Update CLI documentation @[github-actions\[bot\]](https://github.com/apps/github-actions) ([#368](openpubkey/opkssh#368))

##### 🐛 Bug Fixes

- Fix race condition in ReadHome [@gcorrall](https://github.com/gcorrall) ([#391](openpubkey/opkssh#391))
- \[fix] Use lowercase for positional argument placeholders [@t38miwa](https://github.com/t38miwa) ([#361](openpubkey/opkssh#361))
- fix typo in commands/verify.go [@DevRockstarZ](https://github.com/DevRockstarZ) ([#336](openpubkey/opkssh#336))
- Doc: fix small errors in policy plugin doc [@PotatoesMaster](https://github.com/PotatoesMaster) ([#344](openpubkey/opkssh#344))
- Correct macOS name [@stmcginnis](https://github.com/stmcginnis) ([#341](openpubkey/opkssh#341))

##### 🧰 Maintenance

- chore: document upstream nix usage & remove nix flake [@datosh](https://github.com/datosh) ([#383](openpubkey/opkssh#383))
- Update CLI documentation @[github-actions\[bot\]](https://github.com/apps/github-actions) ([#438](openpubkey/opkssh#438))
- Stop hash pinning docker images [@EthanHeilman](https://github.com/EthanHeilman) ([#421](openpubkey/opkssh#421))
- \[fix] Fix ssh version integration test [@EthanHeilman](https://github.com/EthanHeilman) ([#362](openpubkey/opkssh#362))
- Fix integration tests failing due to pacman keys [@EthanHeilman](https://github.com/EthanHeilman) ([#432](openpubkey/opkssh#432))
- fix(deps): Update docker/setup-buildx-action action to v3.12.0 @[renovate\[bot\]](https://github.com/apps/renovate) ([#426](openpubkey/opkssh#426))
- fix(deps): Update zizmorcore/zizmor-action action to v0.3.0 @[renovate\[bot\]](https://github.com/apps/renovate) ([#413](openpubkey/opkssh#413))
- fix(deps): Update peter-evans/create-pull-request action to v8 @[renovate\[bot\]](https://github.com/apps/renovate) ([#418](openpubkey/opkssh#418))
- fix(deps): Update zizmorcore/zizmor-action action to v0.2.0 @[renovate\[bot\]](https://github.com/apps/renovate) ([#335](openpubkey/opkssh#335))
- fix(deps): Update peter-evans/create-pull-request action to v7.0.9 @[renovate\[bot\]](https://github.com/apps/renovate) ([#407](openpubkey/opkssh#407))
sdwilsh pushed a commit to sdwilsh/ansible-playbooks that referenced this pull request Jan 13, 2026
@renovate @sdwilsh
chore(deps): update dependency openpubkey/opkssh to v0.11.0
a7acc4b 
##### [\`v0.11.0\`](https://github.com/openpubkey/opkssh/releases/tag/v0.11.0)

##### 🚀 Features

- Add support for custom group claims [@mvanderlee](https://github.com/mvanderlee) ([#133](openpubkey/opkssh#133))
- feat: Flag to print SSH cert and private key rather than FS [@EthanHeilman](https://github.com/EthanHeilman) ([#437](openpubkey/opkssh#437))
- feat: Process extra arguments to the verify command [@justincmoy](https://github.com/justincmoy) ([#436](openpubkey/opkssh#436))
- Add warning message when email claim is missing from ID token @[copilot-swe-agent\[bot\]](https://github.com/apps/copilot-swe-agent) ([#374](openpubkey/opkssh#374))
- \[feat] Add new "inspect" subcommand [@stmcginnis](https://github.com/stmcginnis) ([#349](openpubkey/opkssh#349))
- Add CLI reference documentation [@stmcginnis](https://github.com/stmcginnis) ([#365](openpubkey/opkssh#365))
- Include signature JSON in `inspect` output [@stmcginnis](https://github.com/stmcginnis) ([#358](openpubkey/opkssh#358))
- - docs: Add Amazon Cognito as tested provider [@Foorack](https://github.com/Foorack) ([#414](openpubkey/opkssh#414))
- docs: Add documentation for opkssh and sssd integration [@vigneshmanick](https://github.com/vigneshmanick) ([#409](openpubkey/opkssh#409))
- Added SELinux support for sudo logging [@descensus](https://github.com/descensus) ([#376](openpubkey/opkssh#376))
- Update CLI documentation @[github-actions\[bot\]](https://github.com/apps/github-actions) ([#368](openpubkey/opkssh#368))

##### 🐛 Bug Fixes

- Fix race condition in ReadHome [@gcorrall](https://github.com/gcorrall) ([#391](openpubkey/opkssh#391))
- \[fix] Use lowercase for positional argument placeholders [@t38miwa](https://github.com/t38miwa) ([#361](openpubkey/opkssh#361))
- fix typo in commands/verify.go [@DevRockstarZ](https://github.com/DevRockstarZ) ([#336](openpubkey/opkssh#336))
- Doc: fix small errors in policy plugin doc [@PotatoesMaster](https://github.com/PotatoesMaster) ([#344](openpubkey/opkssh#344))
- Correct macOS name [@stmcginnis](https://github.com/stmcginnis) ([#341](openpubkey/opkssh#341))

##### 🧰 Maintenance

- chore: document upstream nix usage & remove nix flake [@datosh](https://github.com/datosh) ([#383](openpubkey/opkssh#383))
- Update CLI documentation @[github-actions\[bot\]](https://github.com/apps/github-actions) ([#438](openpubkey/opkssh#438))
- Stop hash pinning docker images [@EthanHeilman](https://github.com/EthanHeilman) ([#421](openpubkey/opkssh#421))
- \[fix] Fix ssh version integration test [@EthanHeilman](https://github.com/EthanHeilman) ([#362](openpubkey/opkssh#362))
- Fix integration tests failing due to pacman keys [@EthanHeilman](https://github.com/EthanHeilman) ([#432](openpubkey/opkssh#432))
- fix(deps): Update docker/setup-buildx-action action to v3.12.0 @[renovate\[bot\]](https://github.com/apps/renovate) ([#426](openpubkey/opkssh#426))
- fix(deps): Update zizmorcore/zizmor-action action to v0.3.0 @[renovate\[bot\]](https://github.com/apps/renovate) ([#413](openpubkey/opkssh#413))
- fix(deps): Update peter-evans/create-pull-request action to v8 @[renovate\[bot\]](https://github.com/apps/renovate) ([#418](openpubkey/opkssh#418))
- fix(deps): Update zizmorcore/zizmor-action action to v0.2.0 @[renovate\[bot\]](https://github.com/apps/renovate) ([#335](openpubkey/opkssh#335))
- fix(deps): Update peter-evans/create-pull-request action to v7.0.9 @[renovate\[bot\]](https://github.com/apps/renovate) ([#407](openpubkey/opkssh#407))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@EthanHeilman EthanHeilman EthanHeilman approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@t38miwa @EthanHeilman