Skip to content

Documentation

libvoid edited this page Nov 3, 2025 · 2 revisions

For every commands, type help to see available options.

config> help
NAME:
   config - A new cli application

USAGE:
   config  [command [command options]]

COMMANDS:
   acl        Manages ACLs
   config     Manages global configuration
   event      Manages events
   host       Manages hosts
   hostgroup  Manages host groups
   info       Shows system-wide information
   key        Manages keys
   user       Manages users
   usergroup  Manages user groups
   userkey    Manages userkeys
   session    Manages sessions
   version    Shows the SSHPortal version information
   exit       Exit
   help, h    Shows a list of commands or help for one command

For example :

config> user help
NAME:
   config user - Manages users

USAGE:
   config user [command [command options]]

COMMANDS:
   inspect  Shows detailed information on one or more users
   invite   Invites a new user
   ls       Lists users
   rm       Removes one or more users
   update   Updates an existing user
config> user invite help
COMMANDS:

GLOBAL OPTIONS:
   --name string                                                            Assigns a name to the user
   --comment string                                                         Adds a comment
   --group USERGROUPS, -g USERGROUPS [ --group USERGROUPS, -g USERGROUPS ]  Names or IDs of USERGROUPS (default: "default")

Clone this wiki locally