diff --git a/README.md b/README.md index 66fddce..07ab057 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,72 @@ To associate this account with a key, use the following SSH user: 'invite-NfHK5a config> ``` +## CLI + +sshportal embeds a configuration CLI. + +By default, the configuration user is `admin`, (can be changed using `--config-user=` when starting the server. + +Each commands can be run directly by using this syntax: `ssh admin@portal.example.org [args]`: + +``` +ssh admin@portal.example.org host inspect toto +``` + +You can enter in interactive mode using this syntax: `ssh admin@portal.example.org` + + +### Synopsis + +```sh +# acl management +acl help +acl create [-h] [--hostgroup=...] [--usergroup=...] [--pattern=] [--comment=] [--action=] [--weight=value] +acl inspect [-h] [ [...]] +acl ls [-h] +acl rm [-h] [ [...]] + +# host management +host help +host create [-h] [--name=] [--password=] [--fingerprint=] [--comment=] [--key=] [--group=] [:]@[:] +host inspect [-h] [ [...]] +host ls [-h] +host rm [-h] [ [...]] + +# hostgroup management +hostgroup help +hostgroup create [-h] [--name=] [--comment=] +hostgroup inspect [-h] [ [...]] +hostgroup ls [-h] +hostgroup rm [-h] [ [...]] + +# key management +key help +key create [-h] [--name=] [--type=] [--length=] [--comment=] +key inspect [-h] [ [...]] +key ls [-h] +key rm [-h] [ [...]] + +# user management +user help +user invite [-h] [--name=] [--comment=] [--group=] +user inspect [-h] [ [...]] +user ls [-h] +user rm [-h] [ [...]] + +# usergroup management +usergroup help +hostgroup create [-h] [--name=] [--comment=] +usergroup inspect [-h] [ [...]] +usergroup ls [-h] +usergroup rm [-h] [ [...]] + +# other +help, h +info [-h] +version [-h] +``` + ## Install Get the latest version using GO (recommended way):