@ricsam/r5d-worker 0.0.1 → 0.0.2

package/README.md

@@ -1,45 +1,25 @@
-# @ricsam/r5d-worker
+# r5d-worker
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+`r5d-worker` connects a local or remote machine to a r5d.dev project so the agent can run host commands through the virtual `worker` shell command.
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+```sh
+r5d-worker start <project-id> --label macos
+```
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+The worker uses the existing `r5dctl` config file and accepts `R5D_WORKER_TOKEN` or `R5D_API_KEY`. Project checkouts are managed under:
 
-## Purpose
+```text
+~/.r5d/projects/<project-id>/<branch-name>
+```
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@ricsam/r5d-worker`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+`main` is cloned from the platform's HTTPS git remote. Other branches are created as git worktrees from the main clone.
 
-## What is OIDC Trusted Publishing?
+Worker labels are mandatory and unique per project. Choose labels that describe host capabilities, such as `macos`, `linux`, `ios`, or `ec2-build`.
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+The agent runs commands through the virtual shell command:
 
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+```sh
+worker exec macos git pull --ff-only build-it-now main
+worker exec macos docker compose up -d
+worker exec macos bun test
+```