diff --git a/docs/client.md b/docs/client.md index 99233af18ac088a36fd75134cf1a3edb97e11ecd..ba86ddbbfcfd905c0a7d966eb13bf8d8cd7f928d 100644 --- a/docs/client.md +++ b/docs/client.md @@ -121,92 +121,99 @@ Welcome to nexush, the nexus shell. Type: "help" for help on commands "quit" or "exit" to quit nexush nexush> help -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― +═════╡ GENERAL commands ╞═════════════════════════════════════════════════════════════════ + ls List files in the specified dir or in the current dir if no argument is specified. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + refresh Obtains a new access token. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + version Display nexus server and client's versions. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + +═════╡ USER commands ╞═════════════════════════════════════════════════════════════════ + whoami Displays the current user's details. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + passwd Updates the current user's password. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + userlist Lists users. Requires USER_LIST user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + usercreate Creates a user. Requires USER_CREATE user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + userdel Deletes one or more users. Requires USER_DESTROY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + usersetcaps Sets a user's capabilities. Requires USER_SET_CAPS user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmlist Lists VMs. - Requires VM_LIST VM access capability or VM_LIST_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmcreds2pdf Creates a PDF with the credentials required to attach to running VMs. - Requires VM_LIST VM access capability or VM_LIST_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmcreds2csv Creates a CSV file with the credentials required to attach to running VMs. - The written CSV file contains 4 columns: VM ID;VM name;port;password - Requires VM_LIST VM access capability or VM_LIST_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmstart Starts one or more VMs. - Requires VM_START VM access capability or VM_START_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmstartwithcreds Starts one or more VMs with user-defined credentials. - Requires VM_START VM access capability or VM_START_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmkill Kills one or more VMs. - Requires VM_STOP VM access capability or VM_STOP_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmshutdown Gracefully shutdowns one or more VMs. - Requires VM_STOP VM access capability or VM_STOP_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmreboot Gracefully reboots one or more VMs. - Requires VM_REBOOT VM access capability or VM_REBOOT_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + +═════╡ TEMPLATE commands ╞═════════════════════════════════════════════════════════════════ + +tplcreate Creates a template from an existing VM. + Requires TPL_CREATE user capability. + +tpldel Deletes a template. + Requires TPL_DESTROY or TPL_DESTROY_ANY user capability. + +tpledit Edits one or more template's properties: name, access. + Requires TPL_EDIT or TPL_EDIT_ANY user capability. + +tplexportdisk Exports a template's disk. + Requires TPL_READFS or TPL_READFS_ANY user capability. + +tpllist Lists templates. + Requires TPL_LIST or TPL_LIST_ANY user capability. + +═════╡ VM commands ╞═════════════════════════════════════════════════════════════════ + +vmaddaccess Adds a user's VM access in one or more VMs. + If not the VM's owner: requires VM_SET_ACCESS user capability and VM_SET_ACCESS VM access capability. + vmattach Attaches to one or more VMs in order to use their desktop environment. - Requires VM_LIST VM access capability or VM_LIST_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + If not the VM's owner: requires VM_ATTACH VM access capability or VM_ATTACH_ANY user capability. + vmcreate Creates one or more VMs. Requires VM_CREATE user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmedit Edits one or more VMs' properties: name, cpus, ram or nic. - Requires VM_EDIT VM access capability or VM_EDIT_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + +vmcreds2pdf Creates a PDF with the credentials required to attach to running VMs. + If not the VM's owner: requires VM_ATTACH VM access capability or VM_ATTACH_ANY user capability. + +vmcreds2csv Creates a CSV file with the credentials required to attach to running VMs. + The written CSV file contains 4 columns: VM ID;VM name;port;password + If not the VM's owner: requires VM_ATTACH VM access capability or VM_ATTACH_ANY user capability. + vmdel Deletes one or more VMs. - Requires VM_DESTROY VM access capability or VM_DESTROY_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -vmaddaccess Adds a user's VM access in one or more VMs. - Requires VM_SET_ACCESS user capability and VM_SET_ACCESS VM access capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + If not the VM's owner: requires VM_DESTROY VM access capability or VM_DESTROY_ANY user capability. + vmdelaccess Removes a user's VM access in one or more VMs. - Requires VM_SET_ACCESS user capability and VM_SET_ACCESS VM access capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + If not the VM's owner: requires VM_SET_ACCESS user capability and VM_SET_ACCESS VM access capability. + +vmedit Edits one or more VMs' properties: name, cpus, ram or nic. + If not the VM's owner: requires VM_EDIT VM access capability or VM_EDIT_ANY user capability. + vmexportdir Exports one or more VMs' directory into one or more compressed archives. - Requires VM_READFS VM access capability or VM_READFS_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― + If not the VM's owner: requires VM_READFS VM access capability or VM_READFS_ANY user capability. + vmimportdir Copies a local directory (or file) and all its content into one or more VMs. - Requires VM_WRITEFS VM access capability or VM_WRITEFS_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -tpllist Lists templates. - Requires TPL_LIST or TPL_LIST_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -tplcreate Creates a template from an existing VM. - Requires TPL_CREATE user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -tpledit Edits one or more template's properties: name, access. - Requires TPL_EDIT or TPL_EDIT_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -tpldel Deletes a template. - Requires TPL_DESTROY or TPL_DESTROY_ANY user capability. -――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― -tplexportdisk Exports a template's disk. - Requires TPL_READFS or TPL_READFS_ANY user capability. + If not the VM's owner: requires VM_WRITEFS VM access capability or VM_WRITEFS_ANY user capability. + +vmkill Kills one or more VMs. + If not the VM's owner: requires VM_STOP VM access capability or VM_STOP_ANY user capability. + +vmlist Lists VMs. + If not the VM's owner: requires VM_LIST VM access capability or VM_LIST_ANY user capability. + +vmreboot Gracefully reboots one or more VMs. + If not the VM's owner: requires VM_REBOOT VM access capability or VM_REBOOT_ANY user capability. + +vmshutdown Gracefully shutdowns one or more VMs. + If not the VM's owner: requires VM_STOP VM access capability or VM_STOP_ANY user capability. + +vmstart Starts one or more VMs. + If not the VM's owner: requires VM_START VM access capability or VM_START_ANY user capability. + +vmstartwithcreds Starts one or more VMs with user-defined credentials. + If not the VM's owner: requires VM_START VM access capability or VM_START_ANY user capability. ``` Note that when attached to a VM's desktop (`vmattach` command), ctrl+F12 toggles between fullscreen/non-fullscreen modes.