From 7e41041b931c9d76850e92f361ba6d23c924f519 Mon Sep 17 00:00:00 2001
From: Florent Gluck <florent.gluck@hesge.ch>
Date: Tue, 19 Jul 2022 00:41:32 +0200
Subject: [PATCH] Updated README.md so it is up-to-date.
---
README.md | 50 ++++++++++----------
src/client_cli/cmdLogin/login.go | 2 +-
src/client_cli/cmdTemplate/templateCreate.go | 2 +-
src/client_cli/cmdTemplate/templateDel.go | 2 +-
src/client_cli/cmdTemplate/templateList.go | 2 +-
src/client_cli/cmdUser/userAdd.go | 2 +-
src/client_cli/cmdUser/userDel.go | 2 +-
src/client_cli/cmdUser/userList.go | 2 +-
src/client_cli/cmdUser/userSetCaps.go | 2 +-
src/client_cli/cmdUser/userUpdatePwd.go | 2 +-
src/client_cli/cmdUser/userWhoami.go | 2 +-
src/client_cli/cmdVM/vmAttach.go | 2 +-
src/client_cli/cmdVM/vmCreate.go | 2 +-
src/client_cli/cmdVM/vmDel.go | 2 +-
src/client_cli/cmdVM/vmDelAccess.go | 2 +-
src/client_cli/cmdVM/vmEdit.go | 2 +-
src/client_cli/cmdVM/vmList.go | 2 +-
src/client_cli/cmdVM/vmListAttach.go | 2 +-
src/client_cli/cmdVM/vmListDel.go | 2 +-
src/client_cli/cmdVM/vmListEdit.go | 2 +-
src/client_cli/cmdVM/vmListEditAccess.go | 2 +-
src/client_cli/cmdVM/vmListStart.go | 2 +-
src/client_cli/cmdVM/vmListStop.go | 2 +-
src/client_cli/cmdVM/vmSetAccess.go | 2 +-
src/client_cli/cmdVM/vmStart.go | 2 +-
src/client_cli/cmdVM/vmStop.go | 2 +-
26 files changed, 50 insertions(+), 50 deletions(-)
diff --git a/README.md b/README.md
index 6e0f23f..7af18f9 100644
--- a/README.md
+++ b/README.md
@@ -35,31 +35,31 @@ Usage: nexus-client CMD
CMD is the Command to run. Except for "login", all Commands require an access token.
The access token is read from the env. variable "NEXUS_TOKEN".
List of supported Commands:
- login Login and obtain an access token
- whoami Display the current user's details
- passwd Update the current user's password
- user_list List one or all users
- user_add Add a user
- user_del Delete one or more users
- user_setcaps Set a user's capabilities
- vmlist List one or more VMs
- vmlist_start List VMs that can be started
- vmlist_attach List VMs that can be attached to
- vmlist_stop List VMs that can be stopped
- vmlist_edit List VMs that can be edited
- vmlist_editaccess List VMs that can have their VM access edited
- vmlist_del List VMs that can be deleted
- vm_start Start a VM
- vm_stop Stop a VM
- vm_attach Attach to a VM in order to see its desktop
- vm_create Create a VM
- vm_edit Create a VM
- vm_del Delete one or more VMs
- vm_setaccess Set a VM Access for a given user
- vm_delaccess Delete VM Access for a given user
- tpl_list List one or more templates
- tpl_create Create a template
- tpl_del Delete one or more templates
+ login Login and obtain an access token.
+ whoami Display the authenticated user's details.
+ passwd Update the current user's password.
+ user_list List users (regex matching).
+ user_add Add a user.
+ user_del Delete one or more users.
+ user_setcaps Set a user's capabilities.
+ vmlist List VMs that can be listed (regex matching).
+ vmlist_start List VMs that can be started (regex matching).
+ vmlist_attach List VMs that can be attached to (regex matching).
+ vmlist_stop List VMs that can be stopped (regex matching).
+ vmlist_edit List VMs that can be edited (regex matching).
+ vmlist_editaccess List VMs that can have their VM access edited (regex matching).
+ vmlist_del List VMs that can be deleted (regex matching).
+ vm_start Start one or more VMs (regex matching).
+ vm_stop Stop one or more VMs (regex matching).
+ vm_attach Attach to a VM in order to use its desktop environment.
+ vm_create Create one or more VMs.
+ vm_edit Edit a VM's properties: name, cpus, ram or nic (regex matching).
+ vm_del Delete one or more VMs (regex matching).
+ vm_setaccess Set the VM access for a given user.
+ vm_delaccess Delete the VM access for a given user.
+ tpl_list List available templates (regex matching).
+ tpl_create Create a template.
+ tpl_del Delete one or more templates.
```
### Compiling nexus-client
diff --git a/src/client_cli/cmdLogin/login.go b/src/client_cli/cmdLogin/login.go
index b8e0da8..a34fcd8 100644
--- a/src/client_cli/cmdLogin/login.go
+++ b/src/client_cli/cmdLogin/login.go
@@ -19,7 +19,7 @@ func (cmd *Login)GetName() string {
}
func (cmd *Login)GetDesc() string {
- return "Login and obtain an access token"
+ return "Login and obtain an access token."
}
func (cmd *Login)PrintUsage() {
diff --git a/src/client_cli/cmdTemplate/templateCreate.go b/src/client_cli/cmdTemplate/templateCreate.go
index da25513..48b608f 100644
--- a/src/client_cli/cmdTemplate/templateCreate.go
+++ b/src/client_cli/cmdTemplate/templateCreate.go
@@ -14,7 +14,7 @@ func (cmd *Create)GetName() string {
}
func (cmd *Create)GetDesc() string {
- return "Create a template"
+ return "Create a template."
}
func (cmd *Create)PrintUsage() {
diff --git a/src/client_cli/cmdTemplate/templateDel.go b/src/client_cli/cmdTemplate/templateDel.go
index f722979..b4c6fda 100644
--- a/src/client_cli/cmdTemplate/templateDel.go
+++ b/src/client_cli/cmdTemplate/templateDel.go
@@ -14,7 +14,7 @@ func (cmd *Del)GetName() string {
}
func (cmd *Del)GetDesc() string {
- return "Delete one or more templates"
+ return "Delete one or more templates."
}
func (cmd *Del)PrintUsage() {
diff --git a/src/client_cli/cmdTemplate/templateList.go b/src/client_cli/cmdTemplate/templateList.go
index 455afa3..49c3916 100644
--- a/src/client_cli/cmdTemplate/templateList.go
+++ b/src/client_cli/cmdTemplate/templateList.go
@@ -9,7 +9,7 @@ func (cmd *List)GetName() string {
}
func (cmd *List)GetDesc() string {
- return "List available templates"
+ return "List available templates (regex matching)."
}
func (cmd *List)PrintUsage() {
diff --git a/src/client_cli/cmdUser/userAdd.go b/src/client_cli/cmdUser/userAdd.go
index 8be5e05..bba0ddd 100644
--- a/src/client_cli/cmdUser/userAdd.go
+++ b/src/client_cli/cmdUser/userAdd.go
@@ -14,7 +14,7 @@ func (cmd *Add)GetName() string {
}
func (cmd *Add)GetDesc() string {
- return "Add a user"
+ return "Add a user."
}
func (cmd *Add)PrintUsage() {
diff --git a/src/client_cli/cmdUser/userDel.go b/src/client_cli/cmdUser/userDel.go
index c6f6d0c..2f57f5d 100644
--- a/src/client_cli/cmdUser/userDel.go
+++ b/src/client_cli/cmdUser/userDel.go
@@ -14,7 +14,7 @@ func (cmd *Del)GetName() string {
}
func (cmd *Del)GetDesc() string {
- return "Delete one or more users"
+ return "Delete one or more users."
}
func (cmd *Del)PrintUsage() {
diff --git a/src/client_cli/cmdUser/userList.go b/src/client_cli/cmdUser/userList.go
index 55902fa..5b0712d 100644
--- a/src/client_cli/cmdUser/userList.go
+++ b/src/client_cli/cmdUser/userList.go
@@ -9,7 +9,7 @@ func (cmd *List)GetName() string {
}
func (cmd *List)GetDesc() string {
- return "List users"
+ return "List users (regex matching)."
}
func (cmd *List)PrintUsage() {
diff --git a/src/client_cli/cmdUser/userSetCaps.go b/src/client_cli/cmdUser/userSetCaps.go
index 2d49448..ea6eaca 100644
--- a/src/client_cli/cmdUser/userSetCaps.go
+++ b/src/client_cli/cmdUser/userSetCaps.go
@@ -14,7 +14,7 @@ func (cmd *SetCaps)GetName() string {
}
func (cmd *SetCaps)GetDesc() string {
- return "Set a user's capabilities"
+ return "Set a user's capabilities."
}
func (cmd *SetCaps)PrintUsage() {
diff --git a/src/client_cli/cmdUser/userUpdatePwd.go b/src/client_cli/cmdUser/userUpdatePwd.go
index 5f6f749..52661ea 100644
--- a/src/client_cli/cmdUser/userUpdatePwd.go
+++ b/src/client_cli/cmdUser/userUpdatePwd.go
@@ -19,7 +19,7 @@ func (cmd *UpdatePwd)GetName() string {
}
func (cmd *UpdatePwd)GetDesc() string {
- return "Update the current user's password"
+ return "Update the current user's password."
}
func (cmd *UpdatePwd)PrintUsage() {
diff --git a/src/client_cli/cmdUser/userWhoami.go b/src/client_cli/cmdUser/userWhoami.go
index cfed13b..4e0f12d 100644
--- a/src/client_cli/cmdUser/userWhoami.go
+++ b/src/client_cli/cmdUser/userWhoami.go
@@ -14,7 +14,7 @@ func (cmd *Whoami)GetName() string {
}
func (cmd *Whoami)GetDesc() string {
- return "Display the authenticated user's details"
+ return "Display the authenticated user's details."
}
func (cmd *Whoami)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmAttach.go b/src/client_cli/cmdVM/vmAttach.go
index 26076a5..d9ea72a 100644
--- a/src/client_cli/cmdVM/vmAttach.go
+++ b/src/client_cli/cmdVM/vmAttach.go
@@ -21,7 +21,7 @@ func (cmd *Attach)GetName() string {
}
func (cmd *Attach)GetDesc() string {
- return "Attach to a VM in order to use its desktop environment"
+ return "Attach to a VM in order to use its desktop environment."
}
func (cmd *Attach)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmCreate.go b/src/client_cli/cmdVM/vmCreate.go
index 203aa38..e6d4868 100644
--- a/src/client_cli/cmdVM/vmCreate.go
+++ b/src/client_cli/cmdVM/vmCreate.go
@@ -15,7 +15,7 @@ func (cmd *Create)GetName() string {
}
func (cmd *Create)GetDesc() string {
- return "Create one or more VMs"
+ return "Create one or more VMs."
}
func (cmd *Create)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmDel.go b/src/client_cli/cmdVM/vmDel.go
index ae4ba72..033d829 100644
--- a/src/client_cli/cmdVM/vmDel.go
+++ b/src/client_cli/cmdVM/vmDel.go
@@ -14,7 +14,7 @@ func (cmd *Del)GetName() string {
}
func (cmd *Del)GetDesc() string {
- return "Delete one or more VMs."
+ return "Delete one or more VMs (regex matching)."
}
func (cmd *Del)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmDelAccess.go b/src/client_cli/cmdVM/vmDelAccess.go
index 862d226..dc09eda 100644
--- a/src/client_cli/cmdVM/vmDelAccess.go
+++ b/src/client_cli/cmdVM/vmDelAccess.go
@@ -14,7 +14,7 @@ func (cmd *DelAccess)GetName() string {
}
func (cmd *DelAccess)GetDesc() string {
- return "Delete the VM Access for a given user"
+ return "Delete the VM access for a given user."
}
func (cmd *DelAccess)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmEdit.go b/src/client_cli/cmdVM/vmEdit.go
index aa8ba53..c9260fd 100644
--- a/src/client_cli/cmdVM/vmEdit.go
+++ b/src/client_cli/cmdVM/vmEdit.go
@@ -24,7 +24,7 @@ func (cmd *Edit)GetName() string {
}
func (cmd *Edit)GetDesc() string {
- return "Edit a VM's properties (name, cpus, ram or nic)"
+ return "Edit a VM's properties: name, cpus, ram or nic (regex matching)."
}
func (cmd *Edit)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmList.go b/src/client_cli/cmdVM/vmList.go
index 844604b..8904086 100644
--- a/src/client_cli/cmdVM/vmList.go
+++ b/src/client_cli/cmdVM/vmList.go
@@ -9,7 +9,7 @@ func (cmd *List)GetName() string {
}
func (cmd *List)GetDesc() string {
- return "List VMs that can be listed"
+ return "List VMs that can be listed (regex matching)."
}
func (cmd *List)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmListAttach.go b/src/client_cli/cmdVM/vmListAttach.go
index e8fb3e9..7837e9b 100644
--- a/src/client_cli/cmdVM/vmListAttach.go
+++ b/src/client_cli/cmdVM/vmListAttach.go
@@ -9,7 +9,7 @@ func (cmd *ListAttach)GetName() string {
}
func (cmd *ListAttach)GetDesc() string {
- return "List VMs that can be attached to"
+ return "List VMs that can be attached to (regex matching)."
}
func (cmd *ListAttach)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmListDel.go b/src/client_cli/cmdVM/vmListDel.go
index 8646047..8b79487 100644
--- a/src/client_cli/cmdVM/vmListDel.go
+++ b/src/client_cli/cmdVM/vmListDel.go
@@ -9,7 +9,7 @@ func (cmd *ListDel)GetName() string {
}
func (cmd *ListDel)GetDesc() string {
- return "List VMs that can be deleted"
+ return "List VMs that can be deleted (regex matching)."
}
func (cmd *ListDel)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmListEdit.go b/src/client_cli/cmdVM/vmListEdit.go
index ca02246..949e585 100644
--- a/src/client_cli/cmdVM/vmListEdit.go
+++ b/src/client_cli/cmdVM/vmListEdit.go
@@ -9,7 +9,7 @@ func (cmd *ListEdit)GetName() string {
}
func (cmd *ListEdit)GetDesc() string {
- return "List VMs that can be edited"
+ return "List VMs that can be edited (regex matching)."
}
func (cmd *ListEdit)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmListEditAccess.go b/src/client_cli/cmdVM/vmListEditAccess.go
index 2d97891..d6b79fc 100644
--- a/src/client_cli/cmdVM/vmListEditAccess.go
+++ b/src/client_cli/cmdVM/vmListEditAccess.go
@@ -9,7 +9,7 @@ func (cmd *ListEditAccess)GetName() string {
}
func (cmd *ListEditAccess)GetDesc() string {
- return "List VMs that can have their VM access edited"
+ return "List VMs that can have their VM access edited (regex matching)."
}
func (cmd *ListEditAccess)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmListStart.go b/src/client_cli/cmdVM/vmListStart.go
index 70a7daa..259b5e6 100644
--- a/src/client_cli/cmdVM/vmListStart.go
+++ b/src/client_cli/cmdVM/vmListStart.go
@@ -9,7 +9,7 @@ func (cmd *ListStart)GetName() string {
}
func (cmd *ListStart)GetDesc() string {
- return "List VMs that can be started"
+ return "List VMs that can be started (regex matching)."
}
func (cmd *ListStart)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmListStop.go b/src/client_cli/cmdVM/vmListStop.go
index 19b473d..b1ab5f2 100644
--- a/src/client_cli/cmdVM/vmListStop.go
+++ b/src/client_cli/cmdVM/vmListStop.go
@@ -9,7 +9,7 @@ func (cmd *ListStop)GetName() string {
}
func (cmd *ListStop)GetDesc() string {
- return "List VMs that can be stopped"
+ return "List VMs that can be stopped (regex matching)."
}
func (cmd *ListStop)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmSetAccess.go b/src/client_cli/cmdVM/vmSetAccess.go
index f0e675a..c8ce795 100644
--- a/src/client_cli/cmdVM/vmSetAccess.go
+++ b/src/client_cli/cmdVM/vmSetAccess.go
@@ -14,7 +14,7 @@ func (cmd *SetAccess)GetName() string {
}
func (cmd *SetAccess)GetDesc() string {
- return "Set the VM Access for a given user"
+ return "Set the VM access for a given user."
}
func (cmd *SetAccess)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmStart.go b/src/client_cli/cmdVM/vmStart.go
index 49f751e..a80a72b 100644
--- a/src/client_cli/cmdVM/vmStart.go
+++ b/src/client_cli/cmdVM/vmStart.go
@@ -14,7 +14,7 @@ func (cmd *Start)GetName() string {
}
func (cmd *Start)GetDesc() string {
- return "Start one or more VMs."
+ return "Start one or more VMs (regex matching)."
}
func (cmd *Start)PrintUsage() {
diff --git a/src/client_cli/cmdVM/vmStop.go b/src/client_cli/cmdVM/vmStop.go
index 072cb80..c1dfe81 100644
--- a/src/client_cli/cmdVM/vmStop.go
+++ b/src/client_cli/cmdVM/vmStop.go
@@ -14,7 +14,7 @@ func (cmd *Stop)GetName() string {
}
func (cmd *Stop)GetDesc() string {
- return "Stop one or more VMs."
+ return "Stop one or more VMs (regex matching)."
}
func (cmd *Stop)PrintUsage() {
--
GitLab