R2
Comprehensive r2 commands and workflows for system administration across all platforms.
Basic Commands
Command | Description |
---|---|
r2 --version |
Show r2 version |
r2 --help |
Display help information |
r2 init |
Initialize r2 in current directory |
r2 status |
Check current status |
r2 list |
List available options |
r2 info |
Display system information |
r2 config |
Show configuration settings |
r2 update |
Update to latest version |
r2 start |
Start r2 service |
r2 stop |
Stop r2 service |
r2 restart |
Restart r2 service |
r2 reload |
Reload configuration |
Installation
Linux/Ubuntu
# Package manager installation
sudo apt update
sudo apt install r2
# Alternative installation
wget https://github.com/example/r2/releases/latest/download/r2-linux
chmod +x r2-linux
sudo mv r2-linux /usr/local/bin/r2
# Build from source
git clone https://github.com/example/r2.git
cd r2
make && sudo make install
macOS
# Homebrew installation
brew install r2
# MacPorts installation
sudo port install r2
# Manual installation
curl -L -o r2 https://github.com/example/r2/releases/latest/download/r2-macos
chmod +x r2
sudo mv r2 /usr/local/bin/
Windows
# Chocolatey installation
choco install r2
# Scoop installation
scoop install r2
# Winget installation
winget install r2
# Manual installation
# Download from https://github.com/example/r2/releases
# Extract and add to PATH
Configuration
Command | Description |
---|---|
r2 config show |
Display current configuration |
r2 config list |
List all configuration options |
r2 config set <key> <value> |
Set configuration value |
r2 config get <key> |
Get configuration value |
r2 config unset <key> |
Remove configuration value |
r2 config reset |
Reset to default configuration |
r2 config validate |
Validate configuration file |
r2 config export |
Export configuration to file |
Advanced Operations
File Operations
# Create new file/resource
r2 create <name>
# Read file/resource
r2 read <name>
# Update existing file/resource
r2 update <name>
# Delete file/resource
r2 delete <name>
# Copy file/resource
r2 copy <source> <destination>
# Move file/resource
r2 move <source> <destination>
# List all files/resources
r2 list --all
# Search for files/resources
r2 search <pattern>
Network Operations
# Connect to remote host
r2 connect <host>:<port>
# Listen on specific port
r2 listen --port <port>
# Send data to target
r2 send --target <host> --data "<data>"
# Receive data from source
r2 receive --source <host>
# Test connectivity
r2 ping <host>
# Scan network range
r2 scan <network>
# Monitor network traffic
r2 monitor --interface <interface>
# Proxy connections
r2 proxy --listen <port> --target <host>:<port>
Process Management
# Start background process
r2 start --daemon
# Stop running process
r2 stop --force
# Restart with new configuration
r2 restart --config <file>
# Check process status
r2 status --verbose
# Monitor process performance
r2 monitor --metrics
# Kill all processes
r2 killall
# Show running processes
r2 ps
# Manage process priority
r2 priority --pid <pid> --level <level>
Security Features
Authentication
# Login with username/password
r2 login --user <username>
# Login with API key
r2 login --api-key <key>
# Login with certificate
r2 login --cert <cert_file>
# Logout current session
r2 logout
# Change password
r2 passwd
# Generate new API key
r2 generate-key --name <key_name>
# List active sessions
r2 sessions
# Revoke session
r2 revoke --session <session_id>
Encryption
# Encrypt file
r2 encrypt --input <file> --output <encrypted_file>
# Decrypt file
r2 decrypt --input <encrypted_file> --output <file>
# Generate encryption key
r2 keygen --type <type> --size <size>
# Sign file
r2 sign --input <file> --key <private_key>
# Verify signature
r2 verify --input <file> --signature <sig_file>
# Hash file
r2 hash --algorithm <algo> --input <file>
# Generate certificate
r2 cert generate --name <name> --days <days>
# Verify certificate
r2 cert verify --cert <cert_file>
Monitoring and Logging
System Monitoring
# Monitor system resources
r2 monitor --system
# Monitor specific process
r2 monitor --pid <pid>
# Monitor network activity
r2 monitor --network
# Monitor file changes
r2 monitor --files <directory>
# Real-time monitoring
r2 monitor --real-time --interval 1
# Generate monitoring report
r2 report --type monitoring --output <file>
# Set monitoring alerts
r2 alert --threshold <value> --action <action>
# View monitoring history
r2 history --type monitoring
Logging
# View logs
r2 logs
# View logs with filter
r2 logs --filter <pattern>
# Follow logs in real-time
r2 logs --follow
# Set log level
r2 logs --level <level>
# Rotate logs
r2 logs --rotate
# Export logs
r2 logs --export <file>
# Clear logs
r2 logs --clear
# Archive logs
r2 logs --archive <archive_file>
Troubleshooting
Common Issues
Issue: Command not found
# Check if r2 is installed
which r2
r2 --version
# Check PATH variable
echo $PATH
# Reinstall if necessary
sudo apt reinstall r2
# or
brew reinstall r2
Issue: Permission denied
# Run with elevated privileges
sudo r2 <command>
# Check file permissions
ls -la $(which r2)
# Fix permissions
chmod +x /usr/local/bin/r2
# Check ownership
sudo chown $USER:$USER /usr/local/bin/r2
Issue: Configuration errors
# Validate configuration
r2 config validate
# Reset to default configuration
r2 config reset
# Check configuration file location
r2 config show --file
# Backup current configuration
r2 config export > backup.conf
# Restore from backup
r2 config import backup.conf
Issue: Service not starting
# Check service status
r2 status --detailed
# Check system logs
journalctl -u r2
# Start in debug mode
r2 start --debug
# Check port availability
netstat -tulpn|grep <port>
# Kill conflicting processes
r2 killall --force
Debug Commands
Command | Description |
---|---|
r2 --debug |
Enable debug output |
r2 --verbose |
Enable verbose logging |
r2 --trace |
Enable trace logging |
r2 test |
Run built-in tests |
r2 doctor |
Run system health check |
r2 diagnose |
Generate diagnostic report |
r2 benchmark |
Run performance benchmarks |
r2 validate |
Validate installation and configuration |
Performance Optimization
Resource Management
# Set memory limit
r2 --max-memory 1G <command>
# Set CPU limit
r2 --max-cpu 2 <command>
# Enable caching
r2 --cache-enabled <command>
# Set cache size
r2 --cache-size 100M <command>
# Clear cache
r2 cache clear
# Show cache statistics
r2 cache stats
# Optimize performance
r2 optimize --profile <profile>
# Show performance metrics
r2 metrics
Parallel Processing
# Enable parallel processing
r2 --parallel <command>
# Set number of workers
r2 --workers 4 <command>
# Process in batches
r2 --batch-size 100 <command>
# Queue management
r2 queue add <item>
r2 queue process
r2 queue status
r2 queue clear
Integration
Scripting
#!/bin/bash
# Example script using r2
set -euo pipefail
# Configuration
CONFIG_FILE="config.yaml"
LOG_FILE="r2.log"
# Check if r2 is available
if ! command -v r2 &> /dev/null; then
echo "Error: r2 is not installed" >&2
exit 1
fi
# Function to log messages
log() \\\\{
echo "$(date '+%Y-%m-%d %H:%M:%S') - $1"|tee -a "$LOG_FILE"
\\\\}
# Main operation
main() \\\\{
log "Starting r2 operation"
if r2 --config "$CONFIG_FILE" run; then
log "Operation completed successfully"
exit 0
else
log "Operation failed with exit code $?"
exit 1
fi
\\\\}
# Cleanup function
cleanup() \\\\{
log "Cleaning up"
r2 cleanup
\\\\}
# Set trap for cleanup
trap cleanup EXIT
# Run main function
main "$@"
API Integration
#!/usr/bin/env python3
"""
Python wrapper for the tool
"""
import subprocess
import json
import logging
from pathlib import Path
from typing import Dict, List, Optional
class ToolWrapper:
def __init__(self, config_file: Optional[str] = None):
self.config_file = config_file
self.logger = logging.getLogger(__name__)
def run_command(self, args: List[str]) -> Dict:
"""Run command and return parsed output"""
cmd = ['tool_name']
if self.config_file:
cmd.extend(['--config', self.config_file])
cmd.extend(args)
try:
result = subprocess.run(
cmd,
capture_output=True,
text=True,
check=True
)
return \\\\{'stdout': result.stdout, 'stderr': result.stderr\\\\}
except subprocess.CalledProcessError as e:
self.logger.error(f"Command failed: \\\\{e\\\\}")
raise
def status(self) -> Dict:
"""Get current status"""
return self.run_command(['status'])
def start(self) -> Dict:
"""Start service"""
return self.run_command(['start'])
def stop(self) -> Dict:
"""Stop service"""
return self.run_command(['stop'])
# Example usage
if __name__ == "__main__":
wrapper = ToolWrapper()
status = wrapper.status()
print(json.dumps(status, indent=2))
Environment Variables
Variable | Description | Default |
---|---|---|
R2_CONFIG |
Configuration file path | ~/.r2/config.yaml |
R2_HOME |
Home directory | ~/.r2 |
R2_LOG_LEVEL |
Logging level | INFO |
R2_LOG_FILE |
Log file path | ~/.r2/logs/r2.log |
R2_CACHE_DIR |
Cache directory | ~/.r2/cache |
R2_DATA_DIR |
Data directory | ~/.r2/data |
R2_TIMEOUT |
Default timeout | 30s |
R2_MAX_WORKERS |
Maximum workers | 4 |
Configuration File
# ~/.r2/config.yaml
version: "1.0"
# General settings
settings:
debug: false
verbose: false
log_level: "INFO"
log_file: "~/.r2/logs/r2.log"
timeout: 30
max_workers: 4
# Network configuration
network:
host: "localhost"
port: 8080
ssl: true
timeout: 30
retries: 3
# Security settings
security:
auth_required: true
api_key: ""
encryption: "AES256"
verify_ssl: true
# Performance settings
performance:
cache_enabled: true
cache_size: "100M"
cache_dir: "~/.r2/cache"
max_memory: "1G"
# Monitoring settings
monitoring:
enabled: true
interval: 60
metrics_enabled: true
alerts_enabled: true
Examples
Basic Workflow
# 1. Initialize r2
r2 init
# 2. Configure basic settings
r2 config set host example.com
r2 config set port 8080
# 3. Start service
r2 start
# 4. Check status
r2 status
# 5. Perform operations
r2 run --target example.com
# 6. View results
r2 results
# 7. Stop service
r2 stop
Advanced Workflow
# Comprehensive operation with monitoring
r2 run \
--config production.yaml \
--parallel \
--workers 8 \
--verbose \
--timeout 300 \
--output json \
--log-file operation.log
# Monitor in real-time
r2 monitor --real-time --interval 5
# Generate report
r2 report --type comprehensive --output report.html
Automation Example
#!/bin/bash
# Automated r2 workflow
# Configuration
TARGETS_FILE="targets.txt"
RESULTS_DIR="results/$(date +%Y-%m-%d)"
CONFIG_FILE="automation.yaml"
# Create results directory
mkdir -p "$RESULTS_DIR"
# Process each target
while IFS= read -r target; do
echo "Processing $target..."
r2 \
--config "$CONFIG_FILE" \
--output json \
--output-file "$RESULTS_DIR/$\\\\{target\\\\}.json" \
run "$target"
done < "$TARGETS_FILE"
# Generate summary report
r2 report summary \
--input "$RESULTS_DIR/*.json" \
--output "$RESULTS_DIR/summary.html"
Best Practices
Security
- Always verify checksums when downloading binaries
- Use strong authentication methods (API keys, certificates)
- Regularly update to the latest version
- Follow principle of least privilege
- Enable audit logging for compliance
- Use encrypted connections when possible
- Validate all inputs and configurations
- Implement proper access controls
Performance
- Use appropriate resource limits for your environment
- Monitor system performance regularly
- Optimize configuration for your use case
- Use parallel processing when beneficial
- Implement proper caching strategies
- Regular maintenance and cleanup
- Profile performance bottlenecks
- Use efficient algorithms and data structures
Operational
- Maintain comprehensive documentation
- Implement proper backup strategies
- Use version control for configurations
- Monitor and alert on critical metrics
- Implement proper error handling
- Use automation for repetitive tasks
- Regular security audits and updates
- Plan for disaster recovery
Development
- Follow coding standards and conventions
- Write comprehensive tests
- Use continuous integration/deployment
- Implement proper logging and monitoring
- Document APIs and interfaces
- Use version control effectively
- Review code regularly
- Maintain backward compatibility
Resources
Official Documentation
Community Resources
Learning Resources
- Getting Started Guide
- Tutorial Series
- Best Practices Guide
- Video Tutorials
- Training Courses
- Certification Program
Related Tools
- Git - Complementary functionality
- Docker - Alternative solution
- Kubernetes - Integration partner
Last updated: 2025-07-06|Edit on GitHub