> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# クイックスタート

> インストールを完了し、コンソールを開き、Waker を作成して最初のタスクを送信します。システム要件、macOS / Linux / Windows でのインストール方法、ログイン、サービス管理、FAQ を含みます。

この章の目標：インストールを完了し、コンソールを開き、Waker を作成して最初のタスクを送信すること。すでに Web Console を開ける場合は、[最初の Waker を作成する](#最初の-waker-を作成する)に直接進んでください。

## システム要件とインストール前の確認

| 項目     | 推奨                                                                          |
| ------ | --------------------------------------------------------------------------- |
| OS     | macOS 13.0+、主要な Linux ディストリビューション、Windows 10+                               |
| メモリ    | 4 GB 以上を推奨                                                                  |
| ディスク容量 | 500 MB 以上の空き容量                                                              |
| ネットワーク | モデルサービス、コードリポジトリ、および使用するコネクタへのアクセスが必要。企業ネットワークでは関連する HTTPS 送信接続を許可する必要があります |

インストール前に、現在のユーザーがプログラムのインストール、バックグラウンドサービスの起動、および対象の作業ディレクトリへのアクセスが可能であることを確認してください。

## インストール

<Tabs>
  <Tab title="macOS">
    macOS ではインストールパッケージまたはコマンドラインのいずれかの方法でインストールできます。

    ### 方法 1：インストールパッケージ

    1. [QoderWake 公式サイト](https://qoder.com.cn/qoderwake) を開きます。
    2. 「MacOS」を選択し、お使いのチップに合わせて「ARM64（Apple Silicon）」または「X64（Intel）」のパッケージを選択します。
    3. `.dmg` をダウンロードして開き、QoderWake を「アプリケーション」にドラッグします。
    4. 「アプリケーション」から QoderWake を開き、プロンプトに従ってアカウント認証を完了し、サービスの起動と Web Console のオープンを待ちます。

    ### 方法 2：コマンドライン

    ターミナルを開いて実行します：

    ```bash theme={null}
    curl -fsSL https://qoder-ide.oss-ap-southeast-1.aliyuncs.com/qoderwake/install.sh | bash
    ```

    実行中はターミナルを閉じないでください。認証ページが表示されたら、認証を完了してターミナルに戻り、終了を待ちます。

    **完了の確認：**

    * ブラウザで Web Console が開く、またはターミナルにコンソールアドレスが表示される。
    * 新しいターミナルで `qoderwake status` を実行するとサービスの状態が返される。

    `qoderwake` が見つからないと表示される場合は、ターミナルを再度開いてください。それでも使用できない場合は、フルパスを使用します：

    ```bash theme={null}
    ~/.qoderwake/bin/qoderwake login
    ```
  </Tab>

  <Tab title="Linux">
    ターミナルを開いて実行します：

    ```bash theme={null}
    curl -fsSL https://qoder-ide.oss-ap-southeast-1.aliyuncs.com/qoderwake/install.sh | bash
    ```

    実行中はターミナルを閉じないでください。認証ページが表示されたら、認証を完了してターミナルに戻り、終了を待ちます。

    **完了の確認：**

    * ブラウザで Web Console が開く、またはターミナルにコンソールアドレスが表示される。
    * 新しいターミナルで `qoderwake status` を実行するとサービスの状態が返される。

    `qoderwake` が見つからないと表示される場合は、ターミナルを再度開いてください。それでも使用できない場合は、フルパスを使用します：

    ```bash theme={null}
    ~/.qoderwake/bin/qoderwake login
    ```
  </Tab>

  <Tab title="Windows">
    1. [QoderWake 公式サイト](https://qoder.com.cn/qoderwake) を開き、Windows インストーラー（`.exe`）をダウンロードします。
    2. インストーラーをダブルクリックし、ウィザードに従ってインストールとアカウント認証を完了します。
    3. サービスの起動と Web Console のオープンを待ちます。

    **完了の確認：** ブラウザで Web Console が開き、Waker 管理ページが正常に読み込まれること。ブラウザが自動的に開かない場合は、コマンドエントリから `qoderwake portal` を実行してください。
  </Tab>
</Tabs>

<Note>
  パッケージ名はバージョンによって変わります。常に公式サイトからダウンロードしてください。インストール時にすでにログイン、サービス起動、Web Console のオープンが完了している場合は、以下のログインと起動コマンドを繰り返す必要はありません。Waker の作成に直接進んでください。
</Note>

## ログイン、アカウント確認、ログアウト

### ブラウザ認証ログイン

以下のコマンドを実行します：

```bash theme={null}
qoderwake login
qoderwake whoami
```

ブラウザで認証を完了します。ブラウザが開かない場合は、ターミナルに表示されたアドレスをコピーしてください。認証がタイムアウトした場合は、再度 `login` を実行します。

**完了の確認：** `qoderwake whoami` で現在のアカウントが表示され、クラウドまたはリモート機能でログインを求められなくなること。

### トークンによるログイン

GUI デスクトップがない場合やブラウザ認証が利用できない場合は、パーソナルアクセストークン（PAT）でログインできます：

```bash theme={null}
QODER_PERSONAL_ACCESS_TOKEN="あなたのトークン" \
  ~/.qoderwake/bin/qoderwake login --method token
```

ファイルからトークンを読み取ることもできます：

```bash theme={null}
qoderwake login --method file --token-file /path/to/token
```

ログイン後に `qoderwake whoami` を実行してください。

<Warning>
  スクリーンショット、タスクメッセージ、またはリポジトリに実際のトークンを保存しないでください。
</Warning>

### アカウントの切り替えまたはログアウト

現在のログイン状態をクリアする場合：

```bash theme={null}
qoderwake logout
```

アカウントを切り替える場合は、`logout`、`login`、`whoami` を順に実行し、Web Console を更新します。ログインしていない場合でもローカルモードは使用可能です。クラウドおよびリモート機能には有効なアカウントが必要です。

## サービスの起動とコンソールのオープン

### 起動してオープン

サービスが起動していない場合：

```bash theme={null}
qoderwake start --open
```

サービスがすでに実行中の場合、Web Console を開きます：

```bash theme={null}
qoderwake portal
```

`portal` は実際のポートを読み取ります。デフォルトアドレスは `http://127.0.0.1:19820` で、ポートが使用中の場合は自動的に次のポートに移ります。

アドレスの表示のみでブラウザを自動的に開かない場合：

```bash theme={null}
qoderwake portal --no-open
```

**完了の確認：** ブラウザで Web Console が開く、または `portal --no-open` で表示されたアドレスにアクセスできること。

### 状態確認、再起動、停止

```bash theme={null}
qoderwake status
qoderwake restart --open
qoderwake stop
qoderwake stop --force
```

| コマンド                       | 使用するタイミング            | 期待される結果                 |
| -------------------------- | -------------------- | ----------------------- |
| `qoderwake status`         | サービスが実行中かどうか不明な場合    | 現在のサービス状態と関連情報が返される     |
| `qoderwake restart --open` | ページの異常、設定またはバージョン更新後 | サービスが再起動し、コンソールが再度開かれる  |
| `qoderwake stop`           | バックグラウンドサービスの通常の停止   | サービスが停止するが、ログイン状態は保持される |
| `qoderwake stop --force`   | 通常の停止が効かない場合         | 強制停止。実行中のタスクが中断される可能性あり |

<Warning>
  停止または再起動の前に、進行中の対話タスク、自動タスク、または WakerFlow がないか確認してください。強制停止は現在の実行を中断する可能性があります。
</Warning>

## 最初の Waker を作成する

<Steps>
  <Step title="Waker 管理を開く">
    `qoderwake portal` を実行し、「Waker 管理」→「新規 Waker」に進みます。
  </Step>

  <Step title="ロールを選択">
    目標の職責に最も近いプリセットロールを選択します。適切なロールがない場合は「カスタムロール」を選択します。
  </Step>

  <Step title="情報を入力">
    名前と説明を入力し、必要に応じてアバターのアップロードや実行環境の選択を行います。
  </Step>

  <Step title="保存して有効化">
    「保存して有効化」をクリックします。
  </Step>
</Steps>

**完了の確認：**

* 新しい Waker が「My Wakers」リストに表示される。
* カードに正しい名前、説明、環境、状態が表示される。

「保存して有効化」がクリックできない場合は、ロールが選択されているか、名前が入力されているか、必須項目がすべて入力されているかを順に確認してください。

## 最初の対話タスクを送信する

<Steps>
  <Step title="対話に入る">
    新しい Waker カードで「対話タスクを作成」をクリックし、Chat の上部に正しい Waker が表示されていることを確認します。
  </Step>

  <Step title="作業ディレクトリを選択">
    ファイルに関係する場合は正しい作業ディレクトリを選択します。必要に応じて添付ファイルを追加するか、`@` でコンテキストを参照します。
  </Step>

  <Step title="試行タスクを送信">
    モデルは「Auto」のまま、読み取り専用の試行タスクを送信します。例：

    ```text theme={null}
    現在のディレクトリの README のみを読み取り、ファイルは変更しないでください。
    プロジェクトの用途と起動方法を 5 つ以内の要点で説明してください。
    情報が不足している場合は明確にその旨を述べてください。
    ```
  </Step>

  <Step title="認証プロンプトに対応">
    タスクを送信します。認証や確認のプロンプトが表示されたら、操作内容を確認してから処理します。
  </Step>

  <Step title="結果を検証">
    最終的な返信を待ち、結果が選択したディレクトリのものであり、要求の範囲を超えていないことを確認します。
  </Step>
</Steps>

**完了の確認：**

* Waker が処理状態に入り、最終的に結果を返す。
* 結果が選択したディレクトリまたは添付ファイルのものであり、タスクの範囲を超えていない。

以上の手順を完了すると、インストール、サービス、アカウント、Waker、および Chat のメインフローがすべて検証されます。

## クイックスタート FAQ

| 現象                               | 優先的に確認                    | 推奨される対処                                            |
| -------------------------------- | ------------------------- | -------------------------------------------------- |
| ターミナルで `qoderwake` が見つからないと表示される | 新しいターミナルでコマンドパスが読み込まれているか | ターミナルを再度開く。必要に応じて `~/.qoderwake/bin/qoderwake` を使用 |
| ブラウザが自動的に開かない                    | ターミナルにアドレスが表示されているか       | アドレスをブラウザにコピーするか、`qoderwake portal --no-open` を実行  |
| デフォルトアドレスにアクセスできない               | サービスが実行中か、実際のポートが変わっていないか | `qoderwake status` と `qoderwake portal` を実行        |
| クラウドまたはリモート機能が利用できない             | 現在のアカウントが有効か              | `qoderwake whoami` を実行し、必要に応じて再ログイン                |
| Waker がローカルファイルにアクセスできない         | 正しい作業ディレクトリが選択されているか      | 入力エリアに戻ってディレクトリを選択し、タスクを再送信                        |
