為什麼您需要 Mavis CLI ?
Mavis CLI 一種透過鍵盤輸入命令來與電腦互動的介面。與圖形使用者介面(GUI)不同,CLI工具不需要使用滑鼠或其他圖形元素,而是透過文字指令來執行各種操作。
對於需要重複的功能操作,您可以透過 Mavis 來進行,但那會花上您大量的時間。 您也可以使用 shell 來撰寫 Mavis CLI 腳本。 亦可以用於串接您的系統,達成流程自動化。
Mavis CLI 可以做什麼?
- 創建和管理專案: 這可能包括創建新的專案、設定專案參數、添加和刪除專案成員等。
- 創建和管理金鑰: 這可能包括生成新金鑰、設定金鑰權限、撤銷金鑰等。
- 創建和管理訪問服務: 這可能包括創建新的訪問服務、設定服務參數、授予和撤銷訪問權限等。
以下將一步步教導您透過 Mavis CLI 創建金鑰與訪問服務
安裝
若您的系統是 Linux 或是 Mac 請在終端機介面執行下列指令
curl -sSL https://releases.pentium.network/mavis/latest/cli.sh | bash
若您的系統是 Windows 的話請點此連間下載
https://releases.pentium.network/mavis/latest/mavis_windows_amd64.zip
Mavis Cli 由主指令與子指令組合而成,以下為主指令與子指令
您可以透過下列指令來執行登入
mavis auth login
-
auth:管理用戶身份驗證。
-
login: 將客戶端登入 Mavis。 -
logout: 將客戶端登出 Mavis。 -
token: 顯示當前的身份驗證令牌。
-
-
completion 為各種 shell 生成自動完成腳本。
-
bash: 為 bash shell 生成自動完成腳本。 -
fish: 為 fish shell 生成自動完成腳本。 -
powershell: 為 powershell 生成自動完成腳本。 -
zsh: 為 zsh shell 生成自動完成腳本。
-
-
config 配置 Mavis CLI 設置。
-
current-project: 顯示當前選擇的專案。 -
set: 設置特定的配置選項。 -
set-project: 設置當前專案。 -
unset: 取消設置特定的配置選項。 -
view: 顯示所有當前的配置選項。
-
-
project 管理 Mavis 專案。(別名:
projects)-
add: 創建一個新的 Mavis 專案。 -
get: 檢索特定專案的資訊。 -
list: 列出所有可用的專案。 -
remove: 刪除一個 Mavis 專案。
-
-
secret 管理 Mavis 專案中的金鑰。
-
add: 在專案中創建一個新的金鑰。(需要-p標誌) -
list: 列出當前專案中的所有金鑰。(需要-p標誌) -
remove: 從當前專案中刪除一個金鑰。(需要-p標誌) -
update: 更新當前專案中的現有金鑰。(需要-p標誌)
-
-
access-service 管理服務訪問。(別名:
as)-
add: 添加訪問服務 -
list: 列出訪問服務 -
remove: 移除訪問服務 -
update: 更新訪問服務(需要-p標誌) 特定命令的標誌
-
-
secret命令需要-p, --project標誌來指定機密所在的專案。
其他資訊
- 對任意主指令與子指令有疑慮 都可以在 指令後方加上" -h " 來查看說明與需要提供的參數
登入
mavis auth login [flags]
- 對當前用戶進行 Mavis 認證。
- 標誌:
-
-a, --account string:用戶的登入名稱(必填)。 -
-p, --password string:用戶的登入密碼(必填)。 -
-h, --help:顯示登入命令的幫助資訊。
-
- 標誌:
登出
mavis auth logout [flags]
- 終止當前用戶的 Mavis 會話。- 標誌:
-
-h, --help:顯示登出命令的幫助資訊。
-
令牌
mavis auth token
- 顯示當前認證令牌(存取令牌)的資訊。
配置(mavis config)
mavis config [command] [flags]
- 管理 Mavis CLI 配置設置。
- 命令:
-
current-project:顯示當前選擇的專案名稱。 -
set:設置特定的配置選項(將 NAME 和 VALUE 替換為所需的選項和值)。 -
set-project --NAME:設置當前專案(將 NAME 替換為專案名稱)。 -
unset NAME:取消設置特定的配置選項(將 NAME 替換為要取消設置的選項)。 -
view:顯示所有當前的配置選項。
-
- 標誌:
-
-h, --help:顯示 config 命令或特定子命令的幫助資訊(使用mavis config [command] --help)。
-
專案命令(mavis project)
- 管理 Mavis 專案。
mavis project [command] [flags]
以下是新增名為 "newpj" 專案的快速參考:
mavis project add -p newpj
- 別名:
list和ls用於list命令,remove和rm用於remove命令。 - 可用命令:
-
add -p string:創建一個新專案。 -
get -p string:檢索特定專案的資訊。 -
list:列出所有可用的專案。 -
remove:刪除現有專案。
-
- 標誌:
-
-h, --help:顯示專案命令或特定子命令的幫助資訊(使用mavis project [command] --help)。 -
-p, --project string:專案名稱(get、remove和update命令必填)。
-
- 管理 Mavis 專案內的機密。
mavis secret [command] [flags]
快速參考:以下是在名為 "CLI" 的專案下新增名為 "new-sef" 的金鑰,包含帳號和密碼:
mavis secret add -n new-sef -a account --password ijf38f -p CLI
-
可用命令:
-
add:在專案中創建新機密。(需要-a或--password標誌)-
-a, --account string:帳號名稱(可選)。 -
-n, --name string:機密名稱(必填)。 -
--password string:機密值(可選,替代-a)。
-
-
list:列出當前專案中的所有機密。 -
remove:從當前專案中刪除機密。 -
update:更新當前專案中的現有機密。(需要-a或--password標誌)-
-a, --account string:帳號名稱(可選)。 -
-n, --name string:機密名稱(必填)。 -
--password string:機密值(可選,替代-a)。
-
-
-
標誌:
-
-h, --help:顯示機密命令或特定子命令的幫助資訊(使用mavis secret [command] --help)。 -
-p, --project string:專案名稱(所有命令必填)。
-
訪問服務命令(mavis as)
mavis secret [command] [flags]
以下是在名為 "CLI" 的專案下新增名為 "newas" 的訪問服務的快速參考,其中機密名稱為 "secname",目標設備名稱為 "device",使用 RDP 協議:
mavis-cli as add -n newas --port 22 -s secname -t device -- protocol rdp
-
可用命令:
-
add:新增訪問服務物件。-
-n, --name string:訪問服務名稱 -
--port int32:端口號 -
-p, --project string:專案名稱 -
--protocol string:協議類型(預設為 "ssh") -
-s, --secret string:機密名稱 -
-t, --targets string:目標伺服器
-
-
list:列出當前專案中的所有機密。 -
remove:從當前專案中刪除機密。 -
update:-
-n, --name string:訪問服務名稱 -
--port int32:端口號 -
-p, --project string:專案名稱 -
-s, --secret string:機密名稱 -
-t, --targets string:目標伺服器,多個目標應以 "," 分隔
-
-