Skip to content

Commit 11d815c

Browse files
committed
requirements for running the .sh files in localhost environments
1 parent b8a70b0 commit 11d815c

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

cache/docs/DETAILED.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,38 @@
44

55
The RERUM API implements an LRU (Least Recently Used) cache with smart invalidation for all read endpoints. The cache intercepts requests before they reach the database and automatically invalidates when data changes.
66

7+
## Prerequisites
8+
9+
### Required System Tools
10+
11+
The cache test scripts require the following command-line tools:
12+
13+
#### Essential Tools (must install)
14+
- **`jq`** - JSON parser for extracting fields from API responses
15+
- **`bc`** - Calculator for arithmetic operations in metrics
16+
- **`curl`** - HTTP client for API requests
17+
18+
**Quick Install (Ubuntu/Debian):**
19+
```bash
20+
sudo apt update && sudo apt install -y jq bc curl
21+
```
22+
23+
**Quick Install (macOS with Homebrew):**
24+
```bash
25+
brew install jq bc curl
26+
```
27+
28+
#### Standard Unix Tools (usually pre-installed)
29+
- `date` - Timestamp operations
30+
- `sed` - Text manipulation
31+
- `awk` - Text processing
32+
- `grep` - Pattern matching
33+
- `cut` - Text field extraction
34+
- `sort` - Sorting operations
35+
- `head` / `tail` - Line operations
36+
37+
These are typically pre-installed on Linux/macOS systems. If missing, install via your package manager.
38+
739
## Cache Configuration
840

941
### Default Settings

0 commit comments

Comments
 (0)