skr

skr は、さくらのクラウドを操作する CLI ツールです。

Warning

🚧 開発中バージョンです。 skr は現在開発中の CLI であり、コマンド、オプション、設定、入出力は変更されることがあります。利用前やアップデート前に、対象コマンドの --help と関連ドキュメントを確認してください。既存の usacloud との互換性は保証しません。

リリースの入手

GitHub Releases から、対象 OS・CPU 向けの ZIP ファイルと SHA-256 チェックサムを取得できます。 バイナリは Linux（amd64、386、arm、arm64）、macOS（amd64、arm64）、Windows（amd64、386）向けに公開します。 ZIP ファイルを展開し、skr（Windows では skr.exe）を PATH の通ったディレクトリに配置してください。

コンテナイメージは ghcr.io/sacloud/skr で公開します。Linux の amd64 と arm64 に対応しています。 バージョンを固定する場合は v 付きのリリースタグを指定してください。latest は最新の正式リリース、dev は main ブランチの開発版です。 プレリリースでは latest を更新しません。Homebrew 向けの配布は行いません。

$ docker run --rm ghcr.io/sacloud/skr:latest --help

コマンド

現在利用できる主なコマンドは次のとおりです。

コマンド	操作できる API
skr iaas-api disk	ディスクの検索、参照、作成、更新、削除
skr iaas-api server	サーバの検索、参照、作成、更新、削除
skr iaas-api switch	スイッチの検索、参照、作成、更新、削除
skr iaas-api zone	ゾーン一覧の取得
skr simplemq-api queue	キューの管理、メッセージ数の確認、キュー内メッセージの削除
skr simplemq-api message	メッセージの送信、受信、タイムアウト延長、削除
skr eventbus-api process-configuration	実行設定の管理、実行先サービス用シークレットの登録
skr eventbus-api schedule	スケジュールの管理
skr eventbus-api trigger	イベントトリガーの管理
skr apprun-dedicated-api	AppRun 専有型のクラスタ、アプリケーション、ワーカノードなどの管理
skr container-registry-api registry	コンテナレジストリと認証ユーザーの管理
skr iam-api user	IAM ユーザーの作成、参照、更新、削除、メールアドレスの登録と解除
skr iam-api group	IAM グループの管理とメンバーシップの更新
skr iam-api policy	組織・プロジェクト・フォルダの IAM ポリシーバインディングの参照と更新
skr iam-api auth	組織の認証条件とパスワードポリシーの参照・更新
skr iam-api folder / project	IAM フォルダとプロジェクトの管理・移動
skr iam-api organization	組織情報とサービス利用ポリシーの管理
skr iam-api iam-role / id-role	IAM ロールと ID ロールの参照
skr iam-api id-policy	組織の ID ポリシーの参照・更新
skr iam-api project-api-key	プロジェクト API キーの管理
skr iam-api service-principal	サービスプリンシパルと公開鍵の管理、アクセストークンの発行
skr iam-api service-policy	サービス利用ポリシーの状態とルールテンプレートの操作
skr iam-api scim	ユーザープロビジョニング設定の管理
skr iam-api sso	SSO プロファイルの管理
skr iam-api user-2fa	ユーザーの OTP、信頼済みデバイス、セキュリティキーの管理
skr http <url>	SDK の認証情報を使った任意の HTTPS エンドポイントへのリクエスト
skr config current	現在選択されているプロファイル名の確認

コマンドの一覧と使い方は、skr --help または各コマンドの --help で確認できます。

$ skr --help
$ skr iaas-api disk --help
$ skr iaas-api switch --help
$ skr simplemq-api --help
$ skr eventbus-api --help
$ skr apprun-dedicated-api --help
$ skr container-registry-api --help
$ skr http --help

サーバの作成では、対象ゾーンで利用できる CPU とメモリの組み合わせを指定します。タグはカンマ区切りの --tags フラグで指定できます。その他の配列を含む設定には JSON の --request を使います。--request と個別フラグは併用できません。作成前に対象環境と料金を確認してください（サーバの作成と削除）。

$ skr iaas-api server create --zone ZONE --name SERVER-NAME --cpu 1 --memory-gb 1 --tags production,web

Disk の作成では --zone、--name、--disk-plan-id、--connection、--size-gb を指定します。更新では --zone と --id に加えて、変更する値だけをフラグで指定できます。省略した値は変更されません。複雑な値は --request にインライン JSON または @path.json で渡せますが、個別フラグとは併用できません。詳しくはDisk API チュートリアルを参照してください。

$ skr iaas-api disk create --zone ZONE --name DISK-NAME --disk-plan-id 4 --connection virtio --size-gb 20 --tags production,web
$ skr iaas-api disk update --zone ZONE --id DISK-ID --name UPDATED-DISK-NAME

認証

サービスプリンシパルキーを基本の認証方式としています。API キー認証も引き続き利用できます。プロファイルの設定方法はプロファイルの管理、API キーの設定方法はAPI キーを使う場合を参照してください。

コマンドによっては API キーやパスワードなど、追加の認証情報が必要です。指定方法は各コマンドの --help と関連ドキュメントを確認してください。

出力

API コマンドの結果は JSON で出力します。 --query に jq 式を指定すると、API の結果を加工できます。詳しくはAPI 出力の jq 加工ガイドを参照してください。

--trace では HTTP リクエストとレスポンスを出力します。認証情報などが含まれる場合があるため、取り扱いに注意してください。 skr http の使い方はHTTP リクエストのガイドを参照してください。

usacloud との違い

skr は、AI からも扱いやすい CLI を目指し、コマンド体系や入出力を一貫した形に再設計しています。そのため、従来の usacloud との互換性は保証しません。移行時に既存のスクリプトや設定の変更が必要になる場合があります。利用前に各コマンドの --help と関連ドキュメントを確認してください。

利用者向けドキュメント

利用者向けドキュメント一覧から、チュートリアルや共通機能の解説を確認できます。 HTML 版は GitHub Pages で公開しています。CLI の全サブコマンドのヘルプも一覧で確認できます。

開発

リポジトリのルートで次のコマンドを実行します。

$ make build
$ ./skr --help
$ make test

リリースは tagpr のリリース PR を main にマージすると開始します。 GoReleaser によるバイナリ公開とコンテナイメージ公開の構成は、リリース設計を参照してください。

ライセンス

このプロジェクトは Apache License 2.0 のもとで公開されています。