@usezynx/cli 0.1.1 → 0.1.2

package/README.md

@@ -0,0 +1,144 @@
+# @usezynx/cli
+
+The native command-line companion for [**ZynxTerminal**](https://usezynx.com) — an
+AI-native, highly configurable terminal and SSH workspace.
+
+`zynx` is a small, fast Rust binary (no Node runtime at execution time). It shares the
+same engine as the ZynxTerminal desktop app, so what you run in the terminal and what you
+script in CI behave identically.
+
+> **Platform:** Windows x64 only for now. macOS/Linux builds are planned. Installing on an
+> unsupported platform is blocked cleanly rather than installing something that can't run.
+
+---
+
+## Install
+
+```bash
+# Global install (recommended)
+npm install -g @usezynx/cli
+
+# Or run once without installing
+npx @usezynx/cli --version
+```
+
+The install pulls a single prebuilt binary matching your OS/arch (`@usezynx/cli-win32-x64`)
+as an optional dependency — there is **no post-install download step**, so it works behind
+corporate proxies and in offline/air-gapped setups.
+
+Verify it:
+
+```bash
+zynx --version
+zynx --help
+```
+
+---
+
+## Commands
+
+### `zynx run -- <command> [args...]`
+
+Run a command inside a native headless pseudo-terminal (ConPTY) and stream its output
+**byte-for-byte** to stdout. The child's **exit code is propagated**, so `zynx run` is safe
+to use in scripts and CI pipelines.
+
+```bash
+# Simple command
+zynx run -- cmd /c echo hello
+
+# Run your test suite; exit code is forwarded to the shell
+zynx run -- npm test
+
+# PowerShell one-liner
+zynx run -- powershell -NoProfile -Command "Get-Date"
+```
+
+Everything after `--` is passed to the child untouched. Program output goes to **stdout**;
+status and errors go to **stderr**, so the stream stays pipeable:
+
+```bash
+zynx run -- npm run build > build.log
+```
+
+> `--profile <name>` is accepted for forward-compatibility but is not wired up yet; the
+> default system shell is used.
+
+### `zynx config get [key]`
+
+Print your ZynxTerminal configuration. With no key, prints the full config as JSON; with a
+key, prints just that value.
+
+```bash
+zynx config get              # full config (pretty JSON)
+zynx config get theme        # -> "system"
+zynx config get fontSize     # -> 16.0
+```
+
+### `zynx config set <key> <value>`
+
+Update a single configuration value. Changes are shared with the desktop app.
+
+```bash
+zynx config set theme dark
+zynx config set fontSize 15
+```
+
+### `zynx whoami`
+
+Show the account you're signed in as. The CLI reads the credential stored by the
+ZynxTerminal desktop app from the Windows Credential Manager and exchanges it for your
+account id.
+
+```bash
+zynx whoami        # -> Logged in as: <uid>   (or "Not logged in.")
+```
+
+> A standalone `zynx login` is not available yet — sign in through the desktop app first.
+> The terminal is fully usable signed-out; accounts are opt-in.
+
+---
+
+## Global flags
+
+| Flag        | Description                                                                 |
+| ----------- | --------------------------------------------------------------------------- |
+| `--json`    | Emit machine-readable JSON status/events on **stderr** (for CI/scripting).  |
+| `--version` | Print the version.                                                          |
+| `--help`    | Print help for `zynx` or any subcommand (e.g. `zynx run --help`).           |
+
+Example:
+
+```bash
+zynx --json run -- npm test
+# stdout: byte-exact test output
+# stderr: {"type":"pty_exit","session":"run","code":0}
+```
+
+---
+
+## Output contract
+
+- **stdout** — the child program's raw output, unmodified. Pipe/redirect it freely.
+- **stderr** — Zynx status messages, prompts, and errors. With `--json`, these become
+  structured JSON lines.
+- **exit code** — mirrors the child process, so `&&`, `||`, and CI gates work as expected.
+
+---
+
+## Security
+
+- Secrets (API keys, tokens, SSH passphrases) live in the **Windows Credential Manager**,
+  never in config files or logs.
+- Log output is passed through a redaction layer that strips keys, tokens, and passwords.
+
+---
+
+## Links
+
+- Website: https://usezynx.com
+- Documentation: https://docs.usezynx.com
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usezynx/cli",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Native CLI for ZynxTerminal (Windows x64)",
   "license": "MIT",
   "os": [
@@ -13,12 +13,13 @@
     "zynx": "bin/zynx.js"
   },
   "files": [
-    "bin/"
+    "bin/",
+    "README.md"
   ],
   "publishConfig": {
     "access": "public"
   },
   "optionalDependencies": {
-    "@usezynx/cli-win32-x64": "0.1.1"
+    "@usezynx/cli-win32-x64": "0.1.2"
   }
 }