@appuo/orbit 1.0.6 → 1.0.10

package/README.md

@@ -1,6 +1,8 @@
-![Orbit](./assets/orbit-header.png)
+![Orbit](./assets/orbit-header.gif)
 
-**Switch Vercel identities instantly.**
+**Orbit by AppUo**
+
+Switch Vercel identities instantly.
 
 No logout. No shell hacks. No credential mess.
 
@@ -52,6 +54,42 @@ pnpm add -g @appuo/orbit
 
 ---
 
+## 🧾 Release & Changelog Flow
+
+Use this flow to keep `CHANGELOG.md` updated on every change/release:
+
+```bash
+# 1) Add an entry while working
+pnpm changelog:add -- --type changed --message "Improve profile auth rollback"
+
+# 2) Bump version for release
+npm version 1.0.9 --no-git-tag-version
+
+# 3) Move [Unreleased] notes into the new version + validate
+pnpm release:prepare
+
+# 4) Publish to GitHub Packages
+npm login --scope=@appuo --auth-type=legacy --registry=https://npm.pkg.github.com
+pnpm release:publish
+
+# One-command release (version bump + changelog + publish + commit/tag/push)
+pnpm release:ship
+# or explicit version:
+pnpm release:ship -- --version 1.0.9
+# run everything except git push:
+pnpm release:ship -- --no-push
+```
+
+Optional npmjs publish:
+
+```bash
+pnpm release:publish:npm
+```
+
+`pnpm changelog:release` will fail if `[Unreleased]` has no entries, to prevent empty release notes.
+
+---
+
 ## ⚡ 30-Second Setup
 
 ```bash
@@ -86,10 +124,20 @@ No `vercel logout`. No `vercel login`. Just switch and go.
 | `orbit exec vercel <cmd>` | Run with active profile |
 | `orbit run vercel <profile> <cmd>` | Run with specific profile |
 | `orbit current` | Show active profile |
+| `orbit rotate-key` | Rotate local encryption key |
 | `orbit remove vercel <profile>` | Remove a profile |
 
 ---
 
+## 🧰 Global Flags
+
+| Flag | Description |
+|------|-------------|
+| `--json` | Machine-readable output for automation |
+| `--debug` | Redacted debug stack traces |
+
+---
+
 ## 🔄 How It Works
 
 When you run `orbit use vercel company`, Orbit:
@@ -116,13 +164,26 @@ No environment variable injection. No wrappers. The Vercel CLI reads its own aut
 ## 🔐 Security
 
 - Tokens encrypted with **AES-256-GCM** at rest
+- Credentials key and token store enforced at `chmod 600`
 - Auth snapshots stored with `chmod 600`
+- Config and auth directories enforced at `chmod 700`
+- Corrupt config/credential files are quarantined before reset
 - No secrets in config files
 - No shell modifications (`.bashrc`, `.zshrc`)
 - Zero native dependencies
 
 ---
 
+## 🧯 Failure Modes & Recovery
+
+- Missing auth snapshot during `orbit use`: command fails safely and does not change current profile.
+- Missing auth snapshot during `orbit exec`/`orbit run`: Orbit falls back to token-scoped env execution.
+- Corrupt `config.json` or `credentials.json`: file is moved to `*.corrupt-<timestamp>` and re-initialized.
+
+See the full runbook in [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md).
+
+---
+
 ## 🖥️ Cross-Platform
 
 | | macOS | Linux | Windows |
@@ -167,6 +228,11 @@ orbit --version
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## 📚 Additional Docs
+
+- [Migration Guide](docs/MIGRATION.md)
+- [Troubleshooting](docs/TROUBLESHOOTING.md)
+
 ## 📄 License
 
 MIT — see [LICENSE](LICENSE).