@ricsam/r5dctl 0.0.1 → 0.0.2

package/README.md

@@ -1,45 +1,71 @@
 # @ricsam/r5dctl
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+CLI for managing r5d.dev platform resources (projects, branches, and sessions).
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+## Installation
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+```bash
+npm install -g @ricsam/r5dctl
+```
 
-## Purpose
+## Login
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@ricsam/r5dctl`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+```bash
+r5dctl auth login
+```
 
-## What is OIDC Trusted Publishing?
+This starts a device-style flow and opens:
 
-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.
+- `https://r5d.dev/r5dctl/login/<requestId>`
 
-## Setup Instructions
+Credentials are stored in:
 
-To properly configure OIDC trusted publishing for this package:
+- `~/.config/r5d/r5dctl/config.json`
 
-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
+## Global Flags
 
-## DO NOT USE THIS PACKAGE
+- `--base-url <url>`
+- `--json`
+- `--config <path>`
+- `--token <token>`
+- `--api-key <key>`
+- `-p, --project <slug|id>`
+- `-b, --branch <branch>`
+- `-s, --session <sessionId>`
 
-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
+## Common Commands
 
-## More Information
+```bash
+r5dctl auth status
+r5dctl auth logout
+r5dctl auth api-key create --name "ci" --save
+r5dctl auth api-key list
+r5dctl auth api-key revoke <key-id>
 
-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)
+r5dctl get projects
+r5dctl create project --name "Demo Project"
+r5dctl describe project <project-ref>
+r5dctl update project <project-ref> --name "Renamed Project" --mode prod
+r5dctl delete project <project-ref>
 
----
+r5dctl -p <project> get branches
+r5dctl -p <project> describe branch <branch>
+r5dctl -p <project> get sessions --branch <branch>
+r5dctl -p <project> create session -b <branch> --name "Spec session"
+r5dctl describe session <session-id>
+r5dctl -s <session-id> update session --name "Renamed session"
+r5dctl -s <session-id> delete session
 
-**Maintained for OIDC setup purposes only**
+r5dctl -s <session-id> conversation           # tool-aware transcript + pending questions/envs
+r5dctl -s <session-id> conversation --full    # same transcript without truncation
+r5dctl -s <session-id> conversation --compact # compact grouped timeline
+r5dctl -s <session-id> prompt --mode plan --model max "..."
+r5dctl -s <session-id> answer-questions -a1 "Recipe Collection" -a2 "Both Manual & AI"
+r5dctl -s <session-id> apply-required-envs -e backend/KEY=value -e frontend/KEY=value
+
+```
+
+Project mode is derived from the persisted `backwardsCompatible` project setting:
+
+- `greenfield`: agent can make breaking/reset-style changes
+- `prod`: agent should keep changes backwards compatible