Help

Commands

Command Description
user Add/modify users
vote Vote for a poll
poll Create/modify polls
category Create/modify categories
yes Confirm previous action
no Abort previous action
vhelp Help: Chain subcommands with '.'

  • user

    Add/modify users

    Commands

    Command Description
    add Add a new user (admin only)
    modify (mod) Modify user name or rights (admin only)
    list (ls) List users

    • user add

      Add a new user (admin only)

      Parameters

      Long Short Default Description
      --privilege= -p USER Privilege for the new User (REVOKED, USER, ADMIN)

      Arguments

      Argument Default Possible Values
      name N/A str

    • user modify

      Modify user name or rights (admin only)

      Flags

      Long Short Description
      --auth -a Use auth of the user directly

      Arguments

      Argument Default Possible Values
      user N/A str
      field N/A name, privilege
      value N/A str

    • user list

      List users

      Arguments

      Argument Default Possible Values
      filter ACTIVE ADMIN, ACTIVE, REVOKED, ALL

  • vote

    Vote for a poll

    Flags

    Long Short Description
    --yes -y autoconfirm changes

    Arguments

    Argument Default Possible Values
    poll_id N/A int
    decision N/A yes, no, abstain
    comment N/A freetext

  • poll

    Create/modify polls

    Commands

    Command Description
    create (call) Create a new poll
    modify (mod) Modify a poll (admin only)
    cancel Cancel a poll (vote caller only)
    veto Veto a poll (admin only)
    decide Decide a poll (admin only)
    expire Change Duration of a poll (admin only)
    list (ls) List polls
    info Info about poll
    url Display address of poll website

    • poll create

      Create a new poll

      Flags

      Long Short Description
      --yes -y Automatically vote yes
      --no -n Automatically vote no
      --abstain -a Automatically abstain

      Parameters

      Long Short Default Description
      --category= -c N/A Category for the poll

      Arguments

      Argument Default Possible Values
      description N/A freetext

    • poll modify

      Modify a poll (admin only)

      Arguments

      Argument Default Possible Values
      poll_id N/A int
      field N/A category, description
      value N/A freetext

    • poll cancel

      Cancel a poll (vote caller only)

      Arguments

      Argument Default Possible Values
      poll_id N/A int

    • poll veto

      Veto a poll (admin only)

      Arguments

      Argument Default Possible Values
      poll_id N/A int
      reason N/A freetext

    • poll decide

      Decide a poll (admin only)

      Arguments

      Argument Default Possible Values
      poll_id N/A int

    • poll expire

      Change Duration of a poll (admin only)

      Arguments

      Argument Default Possible Values
      poll_id N/A int
      value N/A freetext

    • poll list

      List polls

      Parameters

      Long Short Default Description
      --status= -s RUNNING Filter with this status (RUNNING, CANCELED, PASSED, TIED, FAILED, VETOED, DECIDED, ENDED, ALL)
      --category= -c N/A Filter with this category

    • poll info

      Info about poll

      Arguments

      Argument Default Possible Values
      poll_id N/A int

    • poll url

      Display address of poll website

  • category

    Create/modify categories

    Commands

    Command Description
    add Create a new category (admin only)
    modify (mod) Modify a category (admin only)
    list (ls) List categories

    • category add

      Create a new category (admin only)

      Flags

      Long Short Description
      --confidential -s Hide this category on the website

      Parameters

      Long Short Default Description
      --color= -c N/A Color for the category

      Arguments

      Argument Default Possible Values
      name N/A str
      description N/A freetext

    • category modify

      Modify a category (admin only)

      Arguments

      Argument Default Possible Values
      name N/A str
      field N/A description, color, confidential, duration
      value N/A freetext

    • category list

      List categories

  • yes

    Confirm previous action

  • no

    Abort previous action

  • vhelp

    Help: Chain subcommands with '.'

    Arguments

    Argument Default Possible Values
    topic N/A Optional[str]