@docyrus/animaguru 0.10.0 → 0.11.0

package/README.md

@@ -334,6 +334,47 @@ Tokens, client configuration and resumable receipts stay under `~/.config/animag
 
 Only one YouTube command may run at a time. Normal cancellation releases its lock. After a forced process kill, check that no YouTube command is running before removing `youtube/operation.lock` in the configuration directory.
 
+## Cloud sync and versions
+
+CLI 0.11.0 adds `animaguru cloud` for Individual Pro and Team plans. It saves a video workspace, or a standalone video project, to AnimaGuru with every version. Use it to continue on another computer, work with your team and return to earlier versions. Personal cloud projects need your own Individual Pro or Team plan. A team's cloud projects need the team owner's Team plan, and every member can then save and download them.
+
+```sh
+animaguru auth login
+animaguru workspaces use TEAM_ID              # optional: create the cloud project in a team
+animaguru cloud link                         # creates a cloud project for this folder
+animaguru cloud push -m "First cut"          # saves a version
+animaguru cloud status                       # unsaved changes, and whether the cloud is newer
+animaguru cloud pull                         # brings in versions saved elsewhere
+animaguru cloud versions                     # newest first, with who saved each one
+animaguru cloud restore VERSION --path animations/intro/src
+animaguru cloud push                         # saves the restored files as the newest version
+animaguru cloud clone PROJECT_ID my-films    # another computer; run npm install afterwards
+animaguru cloud list
+```
+
+Run the commands anywhere inside the workspace; `--dir PATH` chooses another folder. What is not synced:
+
+- `node_modules/`, `dist/`, `production/exports/` and `production/frames/`;
+- `.env` files except `.env.example`, `.npmrc`, `*credentials*.json`, `*secrets*.json`, keys and logs;
+- anything matched by `.gitignore` or `.animaguruignore`;
+- symbolic links.
+
+Each version is a Git commit in the project's own Cloudflare Artifacts repository. Where a file is stored depends on its type, not its size:
+
+- **Media** (images except SVG, video, audio and ZIP bundles) is uploaded once by SHA-256 at any size, however many versions use it, and Git keeps a small pointer. Media counts toward the plan's media storage: 20 GB for Individual Pro and 100 GB for each team.
+- **Work files** (code, configs, briefs, JSON, SVG, fonts and everything else) are stored in Git at any size up to Artifacts' 32 MB per-file limit. A larger work file stops the push and is named; add it to `.animaguruignore` or move it.
+
+The sync store lives in `.animaguru/sync/`, separate from any Git repository you keep for the folder, and linking adds it to `.gitignore`. Git credentials are short-lived and repository-scoped.
+
+`push` refuses when the cloud has a newer version; `pull` brings it in first. Your other unsaved changes stay. When the same file changed on both sides, `pull` stops and lists it. Then:
+
+- `--prefer local` keeps yours, and the next push replaces the cloud copy;
+- `--prefer cloud` takes the cloud's, and keeps your copy in `.animaguru/sync/backups/`.
+
+`restore` makes the folder, or the `--path` files and folders, match an earlier version without rewriting history. Push afterwards to save the result as the newest version. Replacing unsaved changes requires `--yes` and keeps backups.
+
+Cloud files are never written into ignored or secret paths, through links, or outside the folder. If a plan ends, cloud projects stay readable: list, versions, pull, clone and download still work, but pushing waits until the plan is active again. `cloud unlink` stops syncing a folder without touching the cloud. `cloud delete PROJECT_ID --yes` deletes the project, all its versions and its stored files. The studio's Cloud page lists projects, versions and their files, with downloads.
+
 ## One brand, many animations
 
 ```sh