@fluxlay/cli 1.3.1 → 1.3.2

package/README.md

@@ -2,6 +2,11 @@
 
 CLI for building, developing, and publishing [Fluxlay](https://fluxlay.com) wallpapers.
 
+- Documentation: <https://fluxlay.com/docs/developer/tutorials/getting-started>
+- CLI reference: <https://fluxlay.com/docs/developer/reference/cli/commands>
+- Manifest reference: <https://fluxlay.com/docs/developer/reference/cli/manifest>
+- Examples: <https://github.com/fluxlay/examples>
+
 ## Installation
 
 ```sh
@@ -14,7 +19,7 @@ bun add -g @fluxlay/cli
 
 ### `fluxlay login`
 
-Authenticate with Fluxlay. Opens a browser window for sign-in and stores the session locally.
+Authenticate with your Fluxlay account via device authorization. A browser window opens for sign-in and a confirmation user code is shown. Once approved, the session is stored locally.
 
 ```sh
 fluxlay login
@@ -38,25 +43,43 @@ fluxlay whoami
 
 ### `fluxlay dev [dir]`
 
-Start a development server for a wallpaper project. The Fluxlay app will hot-reload as you edit files.
+Start a development server for live-previewing a wallpaper. The desktop app hot-reloads as you edit files.
 
 ```sh
 fluxlay dev
 fluxlay dev ./my-wallpaper
 ```
 
+| Argument | Description       | Default                 |
+| -------- | ----------------- | ----------------------- |
+| `dir`    | Project directory | `.` (current directory) |
+
+Behavior:
+
+1. Validate `fluxlay.yaml`.
+2. Find an available port starting from 3000.
+3. Start the Vite dev server.
+4. Write `dev.json` to the app data directory.
+5. The desktop app renders the wallpaper with HMR.
+
 ### `fluxlay build [dir]`
 
-Build and package a wallpaper into a `.fluxlay` file.
+Build a wallpaper into an encrypted `.fluxlay` package.
 
 ```sh
 fluxlay build
 fluxlay build ./my-wallpaper -o output.fluxlay
 ```
 
-| Option                | Default             | Description     |
-| --------------------- | ------------------- | --------------- |
-| `-o, --output <name>` | `wallpaper.fluxlay` | Output filename |
+| Argument / Option     | Description       | Default             |
+| --------------------- | ----------------- | ------------------- |
+| `dir`                 | Project directory | `.`                 |
+| `-o, --output <name>` | Output filename   | `wallpaper.fluxlay` |
+
+Requires a logged-in session and a `kind` field in `fluxlay.yaml`. Behavior depends on `kind`:
+
+- `kind: web` — runs the Vite build and packages `dist/`.
+- `kind: video` / `kind: image` — packages the single media file specified by `source` (Vite build is skipped).
 
 ### `fluxlay publish [dir]`
 
@@ -67,16 +90,27 @@ fluxlay publish
 fluxlay publish ./my-wallpaper
 ```
 
-publish の挙動は `fluxlay.yaml` の `kind` フィールドで決まります（CLI フラグでの上書きはありません）。
+| Argument | Description       | Default |
+| -------- | ----------------- | ------- |
+| `dir`    | Project directory | `.`     |
 
-- `kind: web` — Vite ビルド成果物 (`dist/`) をバンドル化
-- `kind: video` / `kind: image` — Vite ビルドはスキップ。`source:` で指定されたメディアファイル単体を `media.<ext>` としてパッケージし、HTML はアプリ側が配信時に動的生成する
+Requires a logged-in session and completed onboarding. Publish behavior is determined by the `kind` field in `fluxlay.yaml` (there is no CLI flag override):
+
+1. Validate `fluxlay.yaml` (`kind` is required).
+2. Generate a content encryption key.
+3. Register the version with the API.
+4. Bundle according to `kind`:
+   - `web`: package the Vite build output (`dist/`).
+   - `video` / `image`: package the media file specified by `source` as `media.<ext>` (Vite build is skipped). HTML is generated dynamically by the desktop app at delivery time.
+5. Encrypt and upload.
+6. Notify the API on completion.
 
 ## Project Structure
 
 A Fluxlay wallpaper project requires a `fluxlay.yaml` manifest at the root:
 
 ```yaml
+schemaVersion: 1
 name: My Wallpaper
 slug: my-wallpaper
 version: 0.1.0
@@ -85,23 +119,27 @@ description: |
   A description of your wallpaper.
 ```
 
-### `fluxlay.yaml` のフィールド
+### `fluxlay.yaml` fields
+
+| Field           | Required                       | Description                                                     |
+| --------------- | ------------------------------ | --------------------------------------------------------------- |
+| `schemaVersion` | ✓                              | Manifest schema version (currently only `1`)                    |
+| `name`          | ✓                              | Display name                                                    |
+| `slug`          | ✓                              | URL-safe unique identifier (lowercase letters, digits, hyphens) |
+| `version`       | ✓                              | Semantic version                                                |
+| `kind`          | ✓                              | Bundle type: `web` / `video` / `image`                          |
+| `source`        | when `kind` is `video`/`image` | Path to the media file to publish (relative to project root)    |
+| `description`   |                                | Short description shown in the store listing                    |
+| `properties`    |                                | Custom property definitions (user-tweakable variables)          |
+| `shell`         |                                | Declared external shell commands                                |
+| `network`       |                                | Allowed network origins                                         |
 
-| フィールド    | 必須                   | 説明                                                        |
-| ------------- | ---------------------- | ----------------------------------------------------------- |
-| `name`        | ✓                      | 壁紙名                                                      |
-| `slug`        | ✓                      | URL スラッグ（小文字英数字とハイフン）                      |
-| `version`     | ✓                      | セマンティックバージョン                                    |
-| `kind`        | ✓                      | バンドル種別 `web` / `video` / `image`                      |
-| `source`      | `video`/`image` の場合 | publish 対象となるメディアファイルのパス（root からの相対） |
-| `description` |                        | 説明文                                                      |
-| `properties`  |                        | カスタムプロパティ定義                                      |
-| `shell`       |                        | 外部コマンド宣言                                            |
-| `network`     |                        | 許可するネットワーク origin                                 |
+For the full schema (including `properties` types and per-type fields), see the [manifest reference](https://fluxlay.com/docs/developer/reference/cli/manifest). Sample projects are available at <https://github.com/fluxlay/examples>.
 
-#### 動画/画像壁紙の例
+#### Video / image wallpaper example
 
 ```yaml
+schemaVersion: 1
 name: My Video Wallpaper
 slug: my-video-wp
 version: 0.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluxlay/cli",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "CLI for building, developing, and publishing Fluxlay wallpapers",
   "keywords": [
     "cli",