[GH-ISSUE #176] The occ twofactorauth:gateway:.. command help should be improved #48

Closed
opened 2026-02-26 05:32:41 +03:00 by kerem · 2 comments
Owner

Originally created by @j-ed on GitHub (Jan 6, 2019).
Original GitHub issue: https://github.com/nextcloud/twofactor_gateway/issues/176

Expected behavior

If you use the occ command line interface, it should provide precise information about how to use the
twofactorauth:gateway:.. commands if the --help switch is used.

Current behavior

The provided information is sometimes a little bit misleading for the following commands:

> ./occ twofactorauth:gateway:configure --help

Usage:
  twofactorauth:gateway:configure <gateway>

Arguments:
  gateway               The identifier (e.g. phone number) of the recipient

More precise for the argument gatewaywould be a text like "The name of the gateway, e.g. 'sms', 'signal', 'telegram', etc."

> ./occ twofactorauth:gateway:test --help
Usage:
  twofactorauth:gateway:test <uid> <gateway> <identifier>

Arguments:
  uid                   The user id
  gateway               The identifier (e.g. phone number) of the recipient
  identifier            The identifier (e.g. phone number) of the recipient

More precise for the argument gatewaywould be a text like "The name of the gateway, e.g. 'sms', 'signal', 'telegram', etc."
More precise for the argument identifier would be a text like "The identifier (e.g. phone number, user id, etc.) of the recipient."

Steps to reproduce

  1. Use the given commands and check the description.

Environment

Server Configuration

OS: Linux 3.16.50
Web server: Apache2 2.4.37
Database: MariaDB 10.2.19
PHP version: 7.2.13
Nextcloud version: 15.0.0
Twofactor_gateway app version: 0.11.0

Client Configuration

Browser: Mozilla Firefox 64.0
Operating system: Windows 10

Originally created by @j-ed on GitHub (Jan 6, 2019). Original GitHub issue: https://github.com/nextcloud/twofactor_gateway/issues/176 ## Expected behavior If you use the occ command line interface, it should provide precise information about how to use the `twofactorauth:gateway:..` commands if the **--help** switch is used. ## Current behavior The provided information is sometimes a little bit misleading for the following commands: ``` > ./occ twofactorauth:gateway:configure --help Usage: twofactorauth:gateway:configure <gateway> Arguments: gateway The identifier (e.g. phone number) of the recipient ``` More precise for the argument `gateway`would be a text like **"The name of the gateway, e.g. 'sms', 'signal', 'telegram', etc."** ``` > ./occ twofactorauth:gateway:test --help Usage: twofactorauth:gateway:test <uid> <gateway> <identifier> Arguments: uid The user id gateway The identifier (e.g. phone number) of the recipient identifier The identifier (e.g. phone number) of the recipient ``` More precise for the argument `gateway`would be a text like **"The name of the gateway, e.g. 'sms', 'signal', 'telegram', etc."** More precise for the argument `identifier` would be a text like **"The identifier (e.g. phone number, user id, etc.) of the recipient."** ### Steps to reproduce 1. Use the given commands and check the description. ## Environment #### Server Configuration OS: Linux 3.16.50 Web server: Apache2 2.4.37 Database: MariaDB 10.2.19 PHP version: 7.2.13 Nextcloud version: 15.0.0 Twofactor_gateway app version: 0.11.0 #### Client Configuration Browser: Mozilla Firefox 64.0 Operating system: Windows 10
kerem 2026-02-26 05:32:41 +03:00
Author
Owner

@ChristophWurst commented on GitHub (Jan 7, 2019):

Yep, that message doesn't help. Could you update github.com/nextcloud/twofactor_gateway@3a0c999340/lib/Command/Configure.php (L64) and submit a pull request? That would be awesome ✌️

<!-- gh-comment-id:451933035 --> @ChristophWurst commented on GitHub (Jan 7, 2019): Yep, that message doesn't help. Could you update https://github.com/nextcloud/twofactor_gateway/blob/3a0c999340d3d2d291e66dd0377f487f63913909/lib/Command/Configure.php#L64 and submit a pull request? That would be awesome :v:
Author
Owner

@j-ed commented on GitHub (Jan 7, 2019):

@ChristophWurst done.

<!-- gh-comment-id:451939963 --> @j-ed commented on GitHub (Jan 7, 2019): @ChristophWurst done.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/twofactor_gateway-nextcloud#48
No description provided.