@glyphteck/veyl 0.58.0 → 0.58.1

package/dist/cli.js

@@ -41125,7 +41125,7 @@ var package_default;
 var init_package = __esm(() => {
   package_default = {
     name: "veyl",
-    version: "0.58.0",
+    version: "0.58.1",
     private: true,
     license: "UNLICENSED",
     workspaces: {

package/dist/index.js

@@ -41124,7 +41124,7 @@ var package_default;
 var init_package = __esm(() => {
   package_default = {
     name: "veyl",
-    version: "0.58.0",
+    version: "0.58.1",
     private: true,
     license: "UNLICENSED",
     workspaces: {

package/package.json

@@ -41,5 +41,5 @@
         "start": "node src/cli.js",
         "lint": "eslint src --quiet"
     },
-    "version": "0.58.0"
+    "version": "0.58.1"
 }

package/readme.md

@@ -1,108 +1,61 @@
 # @glyphteck/veyl
 
-Programmable Veyl SDK with a high-level Node.js 22+ runtime and provider-neutral auth/passkey and account/vault entries for graphical clients. It exposes account, vault, profile, peer, encrypted chat, wallet, Lightning, withdrawal, invite-link, passkey, support, cache, settings, and fleet operations through one JavaScript client and a JSON CLI. A separate read-only MCP resource server exposes the packaged documentation.
+Use a Veyl account from Node.js or the shell. The package provides:
 
-The SDK is a real client, not an admin API. It uses the same shared account, vault, peer, chat, encrypted-cache, and Spark wallet owners as web and iOS. Authentication, vault decryption, message encryption/signing, attachment encryption, and wallet signing remain local.
+- account, profile, and peer management
+- end-to-end encrypted 1:1 chat, files, reactions, and payment requests
+- a self-custodial Spark wallet for peer payments, Lightning, and Bitcoin withdrawals
+- a JavaScript API, JSON CLI, and live events for agents and automations
 
-The public `open()` factory selects the Node runtime ports for filesystem profiles, Firebase transport, Spark, machine credentials, browser-assisted passkeys, and local encrypted cache. Official web and iOS clients use the `@glyphteck/veyl/auth` and `@glyphteck/veyl/account` entries with platform ports for the same passkey orchestration, authenticated user, encrypted settings, public-profile mutation, vault, network, presence, wallet, transfer, transaction, public Bitcoin data, chat-session, peer-directory, profile-search, support/reporting, authenticated push leases, account deletion, and teardown owners. They do not carry separate auth, passkey, account, profile, peer, search, chat, wallet, Bitcoin, transfer, transaction, settings, support, or deletion state machines. The browser/native credential ceremony, native notification presentation, and device-local credential cleanup remain platform behavior.
+Requires Node.js 22 or newer.
 
-## Install the SDK
+## install
 
 ```bash
-npm install @glyphteck/veyl
-# or: pnpm add @glyphteck/veyl
-# or: bun add @glyphteck/veyl
+bun add @glyphteck/veyl
+# or: npm install @glyphteck/veyl
 ```
 
-## JavaScript quick start
-
-Creating an account accepts Veyl's [Terms](https://veyl.glyphteck.com/legal#terms) and [Community Rules](https://veyl.glyphteck.com/community-rules).
+## quick start
 
 ```js
 import { open } from '@glyphteck/veyl';
 
-const veyl = await open({ network: 'REGTEST' });
+const veyl = await open({ profile: 'runner', network: 'REGTEST' });
 const accountKey = await veyl.account.create({ username: 'runner' });
 const vaultKey = await veyl.vault.create();
+
 await veyl.chat.send('@alice', 'hello');
 console.log(await veyl.wallet.balance());
 await veyl.close();
 ```
 
-`account.create()` returns the account key used to authenticate the machine. `vault.create()` returns the vault key that unlocks every vaulted feature. Both keys are saved in the local profile by default and must never be logged or committed.
-
-Machine credentials and passkeys describe authentication capability, not whether a person or agent operates the account. Third-party agents use ordinary public profiles; only namespace-authorized Glyphteck services carry the managed bot marker. Use `REGTEST` for disposable automation and `MAINNET` only for real funds.
+`accountKey` authenticates the account. `vaultKey` unlocks its chat and wallet. By default, both are saved in `~/.veyl/profiles/runner.json` with owner-only permissions so later runs can call `account.login()` and `vault.unlock()` without passing them again.
 
-## Optional CLI
+To store the keys in your own secret manager, pass `saveKey: false` to both creation calls and provide them later through `open({ accountKey, vaultKey })`, `VEYL_ACCOUNT_KEY`, and `VEYL_VAULT_KEY`. Never log or commit either key.
 
-The package also ships a CLI for one-off shell work:
-
-```bash
-npx veyl --network REGTEST account create @runner
-npx veyl vault create
-npx veyl account show
-npx veyl wallet address
-```
+Use `REGTEST` for development and disposable accounts. `MAINNET` uses real funds. Creating an account accepts Veyl's [Terms](https://veyl.glyphteck.com/legal#terms) and [Community Rules](https://veyl.glyphteck.com/community-rules).
 
-To create or log into a normal passkey account from a browser-capable terminal, add `--passkey` to `account create` or `account login`.
+## CLI
 
-Glyphteck's owner-only reserved namespace uses one local key:
+The CLI prints JSON, which makes it suitable for shell scripts and agents.
 
 ```bash
-npx veyl namespace init
-npx veyl --network REGTEST account create @faucet --reserved
-```
-
-Initialization writes the private seed only to `~/.veyl/namespace.seed` with mode `0600` and prints its public identity. The explicit `--reserved` account flow and Glyphteck fleet provisioning sign an exact, short-lived reserved-name claim when that file exists. General users do not possess the key and remain unable to claim reserved names.
-
-Long-running agents should keep one unlocked client or foreground session alive. This reuses the same wallet, peer, chat, cache, and live-listener owners instead of paying cold login and wallet boot cost for every command.
-
-Agents can also mount one conversation through `veyl.chat.enter('@alice')`, or run one local `openFleetOwner(...)` for many accounts. A versioned fleet root derives isolated account keys, vault keys, and Veyl master seeds by monotonically allocated account index, so the operator backs up one root for an unbounded fleet. Fleet policies remain normal API consumers; they receive no Firebase Admin or wallet shortcuts.
-
-The public SDK keeps ordinary errors simple. Only an ambiguous money mutation has a stable `operation_outcome_unknown` contract, including its caller correlation id and whether an identical retry is safe. This prevents an agent from self-correcting a network error into a duplicate spend without building a large error taxonomy.
-
-The [SDK bot fleet example](examples/bot-fleet/readme.md) is a complete public-client policy with replay checkpoints and a durable effect journal. The Glyphteck runtime consumes that same reference policy without receiving privileged backend or wallet access.
-
-```bash
-veyl --profile runner session start
-# another shell
-veyl --profile runner --session default wallet balance
-veyl --profile runner --session default chat enter @alice
-veyl --profile runner --session default session events
-veyl --profile runner --session default session stop
-```
-
-## Documentation discovery
-
-```bash
-veyl docs mcp
-```
-
-The local stdio server advertises packaged Markdown as read-only MCP resources. It cannot access accounts, credentials, chats, or wallets. Agents that control their runtime should import the SDK directly.
-
-## Local state
-
-Profiles live under `~/.veyl` by default. The directory and sensitive files use owner-only permissions.
-
-```text
-VEYL_HOME=/secure/veyl-home
-VEYL_PROFILE=runner
-VEYL_NETWORK=REGTEST
-VEYL_ACCOUNT_KEY=...
-VEYL_VAULT_KEY=...
-VEYL_WEB_URL=https://veyl.glyphteck.com
+bunx veyl --network REGTEST account create @runner
+bunx veyl vault create
+bunx veyl chat send @alice "hello"
+bunx veyl wallet balance
 ```
 
-Use `REGTEST` for development and disposable accounts. Use `MAINNET` only for real funds.
+Run `bunx veyl help` for the full command list. Long-running agents should keep one JavaScript client or persistent CLI session open instead of starting a new wallet and chat session for every action.
 
-## Documentation
+## documentation
 
-- [CLI](docs/cli.md)
 - [JavaScript API](docs/api.md)
-- [Agent operation](docs/agents.md)
-- [Documentation discovery](docs/discovery.md)
-- [Parity and validation](docs/validation.md)
+- [CLI reference](docs/cli.md)
+- [agent operation](docs/agents.md)
+- [MCP documentation discovery](docs/discovery.md)
 
-## License
+## license
 
-The official Veyl JavaScript SDK is distributed under its [proprietary SDK license](LICENSE); it is not currently open source. The license permits use of the unmodified SDK with Veyl, including normal compiled or bundled use, but not modified or standalone redistribution.
+This package is proprietary. The unmodified SDK may be used with Veyl; see the [license](LICENSE) for terms.