なぜ Mavis CLI が必要なのか?
Mavis CLI は、キーボードからコマンドを入力してコンピュータと対話するインターフェースです。グラフィカルユーザーインターフェース(GUI)とは異なり、CLI ツールはマウスや他のグラフィック要素を使用せず、テキストコマンドでさまざまな操作を実行します。
繰り返し操作が必要な場合、Mavis を使うことで効率化できます。しかし、手動では時間がかかることがあります。シェルを利用して 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
CLI の概要
Mavis CLI は メインコマンド と サブコマンド の組み合わせで構成されています。
ログイン
mavis auth login
-
auth:ユーザー認証の管理login:Mavis にクライアントをログインlogout:クライアントをログアウトtoken:現在の認証トークンを表示
-
completion:各種シェル用の自動補完スクリプト生成bash:bash 用fish:fish 用powershell:PowerShell 用zsh:zsh 用
-
設定(config)
current-project:現在選択中のプロジェクトを表示set:特定設定の適用set-project:現在のプロジェクト設定unset:設定解除view:すべての設定を表示
-
プロジェクト管理(project)(
projects)add:新しいプロジェクトを作成get:プロジェクト情報を取得list:プロジェクト一覧remove:プロジェクト削除
-
キー管理(secret)
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 secret)
- 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:ターゲットサーバー(複数の場合は,で区切る)