@puffinstudio/fizzyx 0.4.1 → 0.4.2

package/.fizzy.yaml

@@ -15,13 +15,11 @@ oss:
   dev:
     endpoint: https://youda-uat.oss-cn-beijing.aliyuncs.com
     region: cn-beijing
-    bucket: test
   sync:
     local_dir: ./public
+    remote_prefix: assets
     concurrency: 10
-    bucket: test
   prod:
     endpoint:
     region:
     bucket:
-

package/.fizzyx/oss-manifest.json

@@ -2,7 +2,7 @@
   "version": 1,
   "localDir": "/home/e/.repos/fizzyx/./public",
   "remotePrefix": "assets",
-  "lastSyncedAt": "2026-06-18T04:50:59.235Z",
+  "lastSyncedAt": "2026-06-18T06:16:29.930Z",
   "files": {
     "Monkey_D._Luffy_Anime_Post_Timeskip_Infobox.webp": {
       "mtimeMs": 1781757440085.3743,

package/README.md

@@ -1,84 +1,98 @@
 # fizzyx
 
-AI workflow CLI for Fizzy boards.
-
-`fizzyx` is a Bun + Effect 4 beta CLI that reads `.fizzy.yaml`, stores auth locally, talks to the Fizzy HTTP API directly, and adds project workflow commands optimized for AI agents.
+CLI tool for Fizzy board workflow and OSS/S3-compatible storage management.
 
 ## Install
 
-Install globally with Bun:
-
-```bash
+```sh
 bun add -g @puffinstudio/fizzyx
 ```
 
-Then verify the CLI is available:
+## OSS Commands
 
-```bash
-fizzyx --help
-```
+Manage S3-compatible object storage (Alibaba Cloud OSS, AWS S3, MinIO, etc.).
+
+### Setup
 
-For local development from this repository:
+```sh
+# Interactive blank scaffold (prompts for keys)
+fizzyx oss setup
 
-```bash
-bun install
-bun run build
+# With explicit config (keys are prompted separately)
+fizzyx oss setup --env dev --endpoint https://oss-cn-beijing.aliyuncs.com --region cn-beijing --local-dir ./public [--bucket my-bucket] [--remote-prefix assets]
+
+# Configure keys for an existing environment
+fizzyx oss setup --env dev
 ```
 
-## Setup
+- `--endpoint` and `--region` are required
+- `--bucket` is optional — omit if your endpoint already includes the bucket name (e.g. `https://my-bucket.oss-cn-beijing.aliyuncs.com`)
+- `--remote-prefix` is optional — omit to upload to bucket root
+- Credentials are stored in OS keychain via `Bun.secrets`, never in config files or shell history
+
+### Sync
 
-```bash
-fizzyx setup <board-id>
+Upload local files to the remote bucket:
 
-fizzyx setup --list
+```sh
+fizzyx oss sync [--env dev] [--full] [--no-urls]
 ```
 
-This creates `.fizzy.yaml` with official Fizzy fields plus a `flow:` section.
-`setup --list` prints available board ids and names for the active account.
+- `--env`: environment name (default: `dev`)
+- `--full`: ignore cached manifest, force full re-upload
+- `--no-urls`: suppress file URL output
 
-If TODO/INPROGRESS columns are omitted, `fizzyx setup` auto-discovers them from the API.
+Sync uses a two-stage check (mtime+size → SHA-256 hash) to skip unchanged files. The manifest is stored at `.fizzyx/oss-manifest.json` and can be committed for team sharing.
 
-## Auth
+### List
 
-```bash
-fizzyx auth login <token>
-fizzyx auth status
-```
+List objects in the remote bucket:
 
-Tokens are stored outside the repo under `~/.config/fizzyx/credentials/`.
-
-## Commands
-
-```bash
-fizzyx flow sync
-fizzyx flow mine --fresh
-fizzyx flow status
-fizzyx flow next
-fizzyx flow show 123
-fizzyx flow start 123
-fizzyx flow done 123 "commit abc123: subject"
-fizzyx flow block 123 "waiting on API"
-fizzyx flow add ray "[Page] home · title" --desc /tmp/card.md
-fizzyx flow add ray "[Page] home · title" --desc - < /tmp/card.md
-fizzyx flow steps-from-desc 123
+```sh
+fizzyx oss ls [--env dev] [--prefix assets/]
 ```
 
-During development, you can run the entrypoint directly:
+- `--prefix`: filter objects by key prefix
 
-```bash
-bun run src/main.ts <command>
+### Status
+
+Show sync status (pending uploads, manifest info):
+
+```sh
+fizzyx oss status [--env dev]
 ```
 
-## Architecture
+## Config File (`.fizzy.yaml`)
 
-- `src/domain`: errors and models
-- `src/ports`: repository/API interfaces
-- `src/adapters`: Bun filesystem/cache and fetch-based Fizzy API
-- `src/use-cases`: workflow use cases
-- `src/cli`: thin command parsing and rendering
+Minimal OSS-only config:
+
+```yaml
+oss:
+  dev:
+    endpoint: https://oss-cn-beijing.aliyuncs.com
+    region: cn-beijing
+    bucket: my-bucket
+  sync:
+    local_dir: ./public
+    remote_prefix: assets
+    concurrency: 10
+```
 
-## Check
+If your endpoint already contains the bucket in the hostname, `bucket` can be omitted:
 
-```bash
-bun run check
+```yaml
+oss:
+  dev:
+    endpoint: https://my-bucket.oss-cn-beijing.aliyuncs.com
+    region: cn-beijing
+  sync:
+    local_dir: ./public
 ```
+
+## Credential Resolution
+
+Credentials are resolved in this priority order:
+
+1. OS keychain (`Bun.secrets` — set via `fizzyx oss setup`)
+2. Environment variables: `OSS_<ENV>_ACCESS_KEY_ID` / `OSS_<ENV>_SECRET_ACCESS_KEY`
+3. `.fizzy.yaml` `access_key_id` / `secret_access_key` fields (legacy, discouraged)