@grantex/cli 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,124 @@
+# @grantex/cli
+
+Command-line tool for the [Grantex](https://github.com/mishrasanjeev/grantex) delegated authorization protocol.
+
+Manage agents, grants, audit logs, webhooks, policies, anomalies, and compliance exports from your terminal.
+
+## Install
+
+```bash
+npm install -g @grantex/cli
+```
+
+## Configure
+
+Point the CLI at your Grantex server and set your API key:
+
+```bash
+# Interactive setup
+grantex config set --url https://grantex-auth-dd4mtrt2gq-uc.a.run.app --key YOUR_API_KEY
+
+# Or use environment variables
+export GRANTEX_URL=https://grantex-auth-dd4mtrt2gq-uc.a.run.app
+export GRANTEX_KEY=YOUR_API_KEY
+```
+
+Config is saved to `~/.grantex/config.json`. Environment variables override the config file.
+
+```bash
+# Verify your setup
+grantex config show
+```
+
+## Commands
+
+### Agents
+
+```bash
+grantex agents list
+grantex agents register --name travel-booker --scopes calendar:read,payments:initiate
+grantex agents get ag_01ABC...
+grantex agents update ag_01ABC... --name new-name --scopes calendar:read,email:send
+grantex agents delete ag_01ABC...
+```
+
+### Grants
+
+```bash
+grantex grants list
+grantex grants list --agent ag_01ABC... --status active
+grantex grants revoke grnt_01XYZ...
+```
+
+### Tokens
+
+```bash
+grantex tokens verify <jwt-token>
+grantex tokens revoke <jti>
+```
+
+### Audit Log
+
+```bash
+grantex audit list
+grantex audit list --agent ag_01ABC... --action payment.initiated --since 2026-01-01
+```
+
+### Webhooks
+
+```bash
+grantex webhooks list
+grantex webhooks create --url https://example.com/hook --events grant.created,grant.revoked
+grantex webhooks delete wh_01XYZ...
+```
+
+Supported events: `grant.created`, `grant.revoked`, `token.issued`
+
+### Compliance
+
+```bash
+# Summary stats
+grantex compliance summary
+grantex compliance summary --since 2026-01-01 --until 2026-02-01
+
+# Export grants
+grantex compliance export grants --format json --output grants.json
+
+# Export audit log
+grantex compliance export audit --format json --output audit.json
+
+# Evidence pack (SOC 2, GDPR, etc.)
+grantex compliance evidence-pack --framework soc2 --output evidence.json
+```
+
+### Anomaly Detection
+
+```bash
+grantex anomalies detect
+grantex anomalies list
+grantex anomalies list --unacknowledged
+grantex anomalies acknowledge anom_01XYZ...
+```
+
+## Local Development
+
+For local development with `docker compose`:
+
+```bash
+grantex config set --url http://localhost:3001 --key dev-api-key-local
+```
+
+## Requirements
+
+- Node.js 18+
+
+## Links
+
+- [Grantex Protocol](https://github.com/mishrasanjeev/grantex)
+- [TypeScript SDK](https://www.npmjs.com/package/@grantex/sdk)
+- [Self-Hosting Guide](https://github.com/mishrasanjeev/grantex/blob/main/docs/self-hosting.md)
+- [Developer Portal](https://grantex.dev/dashboard)
+
+## License
+
+Apache 2.0

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@grantex/cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "CLI tool for local Grantex development",
   "type": "module",
   "bin": {
     "grantex": "./dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",