palmagent 0.0.1-alpha.0 → 0.1.0-alpha.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Palmagent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+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, 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,8 +1,38 @@
-# palmagent
+# Palmagent
 
-🚧 **Coming soon.**
+Self-hosted dispatcher that drives the Claude Code and Codex CLIs headless on your own
+host, normalizes their two event streams into one schema, and serves an installable,
+mobile-first PWA over SSE (read) + REST (control).
 
-This package is a placeholder that reserves the npm name `palmagent`.
-The real tool isn't published yet — there's nothing to install or run for now.
+## Requirements
 
-Watch this space.
+- Node.js >= 22
+- At least one of the `claude` or `codex` CLIs on PATH and authenticated
+- A public domain pointing at this host (TLS + passkey auth need a real https origin)
+- Linux with systemd + nginx and sudo (the installer writes units + an nginx vhost)
+
+## Quickstart
+
+Use the Palmagent operator plugin in Claude Code or Codex to install and manage the service.
+The plugin handles CLI installation and commands internally; users do not run this CLI directly.
+Ask the plugin to install Palmagent, show settings, choose Preview, or update the service.
+
+Stable is the default for new users. Preview is an explicit choice available to everyone.
+Both plugins share ~/.palmagent/config.json; settings survive updates and service reinstalls.
+Changing the saved channel does not deploy a release. Updates refuse downgrades and
+prereleases on Stable; a missing Stable release does not fall back to Preview.
+Ask the plugin to enable automatic updates for idle periods within the current compatibility line.
+Automatic updates are off by default; a required plugin change or failed installation needs attention.
+
+## Internal commands
+
+- `palmagent config`     Shared user settings: get, init, set --channel stable|preview
+- `palmagent auto-update` Background timer: enable, disable, status
+- `palmagent install`    First-run setup: systemd units, nginx, TLS (certbot), first passkey
+- `palmagent setup`      Reconfigure an existing install + re-render units/nginx
+- `palmagent doctor`     Diagnose a running instance + suggest fixes
+- `palmagent update`     `--plan` resolves package/plugin actions; `--pull` applies with installed plugin manifests
+- `palmagent uninstall`  Remove the units + nginx vhost (data preserved unless `--purge`)
+- `palmagent passkey`    Mint a fresh device-enroll link
+
+Run `palmagent --help` for the full option list.

package/build-info.json

@@ -0,0 +1,5 @@
+{
+  "version": "0.1.0-alpha.3",
+  "sourceCommit": "e8b39630a0a35e97a1f78207a9a2509a56971fb0",
+  "dirty": false
+}