@ariobarin/glossa 0.1.0-beta.1 → 0.1.0-beta.10

package/LICENSE

@@ -12,4 +12,10 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,20 +1,52 @@
-# @ariobarin/glossa
-
-This package contains the `glossa` executable. Install the private beta from npm:
-
-```powershell
-npm install --global @ariobarin/glossa@beta
-glossa login
-glossa status
-glossa whoami
-Set-Location C:\path\to\a\repository
-glossa
-```
-
-Login uses Auth0 Device Authorization Flow. Public tenant, client, and API identifiers are built in, so testers do not configure OAuth values.
-
-OAuth and device credentials use the operating-system credential store. If it is unavailable, Glossa warns before using a restricted credential file.
-
-The first managed session enrolls the computer under its hostname. Running `glossa` inside a Git worktree exposes only that worktree root. The process prints the canonical root, shell authority warning, and write or command activity. Press Ctrl+C to disconnect.
-
-The managed endpoint defaults to `https://mcp.glossa.sh`. Development deployments may override `GLOSSA_RELAY_ORIGIN` and `GLOSSA_WORKER_ORIGIN`. Plain HTTP is accepted only for loopback relay origins and loopback or private IPv4 worker origins.
+# @ariobarin/glossa
+
+This package contains the npm distribution of the `glossa` executable. Node.js
+22.9 or newer is required for this installation method.
+
+The recommended open-beta install on Windows, macOS, and Linux uses npm:
+
+```shell
+npm install --global @ariobarin/glossa@beta
+```
+
+Glossa also provides a self-contained direct installer that does not require
+Node.js or npm.
+
+Windows:
+
+```powershell
+irm https://glossa.sh/install | iex
+```
+
+macOS or Linux:
+
+```shell
+curl -fsSL https://glossa.sh/install.sh | sh
+```
+
+Then choose a recognizable name during this computer's first enrollment:
+
+```shell
+cd path/to/a/project
+glossa --device-name "my-workstation" .
+```
+
+The hosted commands run the tracked scripts in `site`. They verify native
+release checksums before installing. Use `glossa update` or its
+`glossa upgrade` alias to update later with the original installation method.
+
+Glossa opens Google sign-in automatically when needed using OAuth Device Authorization Flow. Public client and resource identifiers are built in, so testers do not configure OAuth values. Use the same Google account when authorizing Glossa in ChatGPT.
+
+OAuth and device credentials use the operating-system credential store. If it is unavailable, Glossa warns before using a restricted credential file.
+
+`--device-name` is used only during initial enrollment. Later starts reuse the enrolled name; use `glossa devices rename <id> <name>` to change it. Without the option, the first managed session enrolls the computer under its hostname. `glossa start .` selects the current directory explicitly. Each process registers an independent workspace, so the same computer may expose several workspaces at once. The process prints the canonical root, connection state, shell authority warning, and write or command activity. Press Ctrl+C to disconnect.
+
+The experimental `glossa ui .` command opens a compact live session HUD and immediately exposes the selected workspace. Press `d` for recent activity, `?` for help, and `q` to disconnect. The screen keeps the worker-account authority warning visible.
+
+Glossa signs in automatically whenever an authenticated command needs an account. `glossa login` is an optional preflight. `glossa status` validates the session and relay, then reports enrolled devices and active workers. `glossa doctor` performs a read-only readiness check, including the local device credential, and supports `--json`. Use `glossa devices list`, `glossa devices rename <id> <name>`, and `glossa devices revoke <id>` to manage enrolled computers.
+
+Generate shell completion with `glossa completions <powershell|bash|zsh|fish>` and source the output from your shell profile. For example, use `glossa completions powershell | Out-String | Invoke-Expression` in PowerShell, `source <(glossa completions bash)` in Bash, `source <(glossa completions zsh)` after `compinit` in Zsh, or `glossa completions fish | source` in Fish.
+
+The managed endpoint defaults to `https://mcp.glossa.sh`. Development deployments may override `GLOSSA_RELAY_ORIGIN` and `GLOSSA_WORKER_ORIGIN`. Plain HTTP is accepted only for loopback relay origins and loopback or private IPv4 worker origins.
+
+Run `glossa logout` to remove the CLI's local OAuth credentials. Running workers remain connected until stopped or revoked. Run `glossa logout --browser` before switching Google accounts so the next Glossa authorization does not silently reuse the previous browser session.