Skip to content

Clique usage and {error, 1} #104

@martinsumner

Description

@martinsumner

Note, although this is probably a clique error, recording the issue here to help with tracking. It may require a change to how clique is used.

When asking for help from a clique registered CLI command - it may return after the help {error, 1} or ok.

e.g.

rel/riak/bin/riak admin handoff --help 
Usage: riak-admin handoff <sub-command>

  Display handoff-related status and settings.

  Sub-commands:
    enable     Enable handoffs for the specified node(s)
    disable    Disable handoffs for the specified node(s)
    summary    Show cluster-wide handoff summary
    details    Show details of all active transfers (per-node or cluster wide)
    config     Show all configuration for handoff subsystem

  Use --help after a sub-command for more details.

{error,1}

but ...

rel/riak/bin/riak admin handoff enable inbound --help
Usage: riak-admin handoff <enable|disable> <inbound|outbound|both> [-n <node>|--all]

  Enable or disable handoffs on the local or specified node(s).
  If handoffs are disabled in a direction, any currently
  running handoffs in that direction will be terminated.

Options
  -n <node>, --node <node>
      Modify the setting on the specified node.
      This flag can currently take only one node and be used once
  -a, --all
      Modify the setting on every node in the cluster
ok

The {error, 1} appears to happen when the potentially wildcarded inputs pre --help don't match a registered command.
i.e. ["riak-admin", "handoff"] and ["riak-admin", *] do not match registered commands, as they are the wrong length even with the wildcard. While ["riak-admin", "handoff", "enable", "inbound"] does, so there is an ok returned to the help request.

The {error, 1} is unexpected output to the user.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions