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

概要

initコマンドは、プロジェクトの設定から最初のスキーマ取得までを 1つの対話フローで完了します。

実行内容

  1. 生成するスキーマの保存先を確認
  2. notcms.config.jsonを作成
  3. .env、.env.local、.dev.varsから既存の認証情報を読み込み
  4. 認証情報がなければブラウザログインを提案し、.env.localへ保存
  5. notcmsが直接依存として宣言され、プロジェクトから解決可能かを確認
  6. スキーマを自動取得
  7. 生成されたncクライアントを使う最初のクエリを表示
ブラウザログインを拒否した場合も設定ファイルは残り、後から notcms loginを実行する方法を表示します。認証情報なしでpullは実行しません。

オプション

対話型セットアップ

最初に、生成するスキーマの保存先を確認します:
認証情報がない場合は、ブラウザログインを開始する前に確認します:
ブラウザにはデバイスコードとワークスペース選択が表示されます。認証後に 返された認証情報は、そのまま自動スキーマ取得に利用されます。 initは、notcmsがdependenciesまたはdevDependenciesに直接宣言され、 対象プロジェクトから解決できる場合だけセットアップ済みと判断します。直接宣言済みでも 未インストールの場合は、ローカル・workspace・固定バージョンなど既存の依存指定を 維持するため、package managerの通常のinstallコマンドを提案します:
直接宣言されていない場合は、対応するaddコマンドを提案します:
実行前に正確なコマンドを表示し、デフォルトyesで確認します。POSIX環境ではshell modeを無効にしてpackage managerを直接実行します。Windowsではpackage managerの .cmd shimを起動するため、固定された検証済み引数だけをcmd.exeへ渡し、 プロジェクト由来の文字列をコマンドへ展開しません。拒否、インストール失敗、 非対話セッションの場合もスキーマ生成を続け、最後に手動インストールコマンドを 表示します。 package managerは、有効なpackageManagerフィールド、最も近いlockfile、または 起動元package managerから選択します。明示されたフィールドが無効な場合や、最も近い 場所に競合するlockfileがあり起動元からも判定できない場合は、自動実行しません。 スキーマ生成は完了させたうえで、package manager設定を手動で解決する方法を表示します。

例

基本的な初期化

独自の環境ファイルから認証情報を読み込む

次のステップ

生成されたスキーマファイルからncクライアントをimportし、コマンドが表示した クエリを実行します。Notionデータベースの構造を変更した後は、次のコマンドで 更新できます:
CI でスキーマを確認する