メインコンテンツへスキップ

概要

Blocklet CLIは、Blocklet Serverの管理とblocklet開発のための主要なツールです。ローカルでの開発やテストから、アプリケーションのパッケージング、デプロイまで、あらゆる作業に対応する包括的なコマンドセットを提供します。

コマンドは2つの主要なカテゴリに分類されており、サーバー環境の管理と個々のblockletプロジェクトの作業との間で、関心事が明確に分離されています。

Overview

コマンド構造

  • blocklet server <subcommand>: このコマンドグループは、Blocklet Serverデーモンの管理に特化しています。サーバープロセスの初期化、開始、停止、監視に使用します。
  • blocklet <command>: これらのコマンドは、個々のblockletのライフサイクル全体で使用されます。これには、新規プロジェクトの足場作り、ローカル開発環境の実行、依存関係の管理、本番環境向けのバンドル、サーバーへのデプロイが含まれます。

主な機能

サーバー管理

Blocklet Serverのライフサイクルを制御します。サーバー設定の開始、停止、ステータス確認、ログ表示、管理を行います。

プロジェクトの足場作り

公式のスターターテンプレートから新しいblockletプロジェクトを迅速に作成したり、空のプロジェクト構造を初期化したりします。

ローカル開発

ライブリロード開発モードでblockletを実行し、スクリプトを実行し、ローカルのテスト環境を管理します。

パッケージングと配布

blockletとその依存関係を配布可能なパッケージにバンドルし、サーバーにデプロイするか、Blocklet Storeにアップロードします。

初回実行時の体験

新規インストール後に初めてCLIを使用すると、ウェルカムメッセージが表示されます。これは、CLIが正しくインストールされ、使用準備が整っていることを確認するための一度だけの表示です。

初回実行時のウェルカムメッセージ

text
Powered By
   _            _                      _
  / \   _ __ | | __ _ | |__    ___  _ __ | | __
 / _ \ | '__|| |/ /` || '_ \  / _ \| '__|| |/ /
/ ___ \| |   |   < | || |_) ||  __/| |   |   <
/_/   \_\_|   |_|\_\\_||_.__/  \___||_|   |_|\_\

        Blocklet CLI vX.Y.Z

ヘルプの利用

任意のコマンドに --help を追加することで、そのコマンドのヘルプを取得できます。利用可能なすべてのコマンドのリストを表示するには、引数なしで blocklet を実行してください。

コマンドのヘルプを取得する

bash
# 'deploy' コマンドのヘルプを取得
blocklet deploy --help

# すべてのトップレベルコマンドを一覧表示
blocklet --help

次のステップ

Blocklet CLIで何ができるかについて大まかに理解できたので、次にインストールして実行してみましょう。

はじめに

ステップバイステップのガイドに従ってCLIをインストールし、最初のBlocklet Serverインスタンスを実行します。

CLIのインストール