cacheroo

CLI for the Cacheroo agent-first cache platform. Provision cache namespaces with one command.

Zero dependencies. Built on Node.js built-ins only. Requires Node >= 18.

Quick Start

# Provision a namespace (no account needed)
npx cacheroo signup myproject

# Verify for $1/mo Pro plan
cacheroo verify

# Start caching
cacheroo set greeting "hello world"
cacheroo get greeting

Install

npm install -g cacheroo

Commands

Account

| Command | Description | |---------|-------------| | signup <tenantId> | Provision a new cache namespace | | login | Save API key to config | | logout | Remove saved credentials | | me | Show account info | | verify [tenantId] | Open browser for $1 plan activation |

Namespace

| Command | Description | |---------|-------------| | status | Show namespace usage and limits |

Cache Operations

| Command | Description | |---------|-------------| | set <key> <value> [--ttl <s>] | Store a value | | get <key> | Retrieve a value | | del <key> | Delete a key | | keys [pattern] | List keys (default: *) | | info [section] | Redis INFO (default: memory) | | url | Print redis:// connection string |

Global Options

| Option | Description | |--------|-------------| | --key <apiKey> | Override API key | | --base-url <url> | Override base URL | | --json | Output as JSON | | --local | Use project-local config (./.cacheroo/) | | --version | Show version |

Config Resolution

The CLI resolves your API key in this order (first match wins):

1. --key flag
2. CACHEROO_API_KEY environment variable
3. ./.cacheroo/config.json (project-local)
4. ~/.cacheroo/config.json (global)

API keys use the prefix cr_free_ (free tier) or cr_pro_ (pro tier).

Agent Integration

Add Cacheroo to your AI agent's context so it can provision and use caches automatically.

CLAUDE.md

## Cache

This project uses Cacheroo for caching. The CLI is available as `cacheroo`.

- Provision: `cacheroo signup <namespace>`
- Set: `cacheroo set <key> <value> [--ttl <seconds>]`
- Get: `cacheroo get <key>`
- Delete: `cacheroo del <key>`
- Status: `cacheroo status`
- Connection string: `cacheroo url`

Config is stored in `.cacheroo/config.json` (already in .gitignore).

.cursorrules

## Cache

Use `cacheroo` CLI for cache operations:
- cacheroo signup <namespace> — provision a cache
- cacheroo set <key> <value> [--ttl <seconds>] — store a value
- cacheroo get <key> — retrieve a value
- cacheroo del <key> — delete a key
- cacheroo keys [pattern] — list keys
- cacheroo url — get redis:// connection string

.clinerules

## Cache

Use `cacheroo` CLI for cache operations:
- cacheroo signup <namespace> — provision a cache
- cacheroo set <key> <value> [--ttl <seconds>] — store
- cacheroo get <key> — retrieve
- cacheroo del <key> — delete
- cacheroo url — connection string

.windsurfrules

## Cache

Use `cacheroo` CLI for cache operations:
- cacheroo signup <namespace> — provision a cache
- cacheroo set <key> <value> [--ttl <seconds>] — store
- cacheroo get <key> — retrieve
- cacheroo del <key> — delete
- cacheroo url — connection string

.aider.conf.yml

# Cache operations via cacheroo CLI
# cacheroo signup <namespace> — provision
# cacheroo set <key> <value> [--ttl <seconds>] — store
# cacheroo get <key> — retrieve
# cacheroo del <key> — delete
# cacheroo url — connection string

Connection Info

After signup, your Redis connection string is stored in your config file. Use it directly:

# Print connection string
cacheroo url

# Use in your app
REDIS_URL=$(cacheroo url) node app.js

Or access it programmatically from .cacheroo/config.json:

{
  "apiKey": "cr_free_abc123...",
  "baseUrl": "https://cacheroo.com",
  "tenantId": "myproject",
  "redisUrl": "redis://:password@host:port/0"
}

License

MIT - Tyga.Cloud Ltd