WAKE

For an interactive experience, launch the Terminal UI (TUI) mode. This allows for real-time filtering, searching, and navigation within your terminal.

wake --ui

Use arrow keys to scroll, f to filter, and q to quit.

🔍 Show TUI Screenshot

Wake can send filtered logs to a web endpoint for viewing. This is great for sharing and collaboration. It integrates with OpenObserve.

Before you start:

mkdir -p data
chmod +x data

Step 1: Start OpenObserve with Docker

docker run -d \
  --name openobserve \
  -v $PWD/data:/data \
  -p 5080:5080 \
  -e ZO_ROOT_USER_EMAIL="root@example.com" \
  -e ZO_ROOT_USER_PASSWORD="Complexpass#123" \
  -e ZO_COMPACT_DATA_RETENTION_DAYS=3 \
  -e ZO_ORG_DATA_QUOTA=10737418240 \
  -e ZO_STREAM_DATA_QUOTA=2147483648 \
  public.ecr.aws/zinclabs/openobserve:latest

What this does:

• -d – Run in background
• --name openobserve – Container name for easy management
• -v $PWD/data:/data – Mount local data directory for persistence
• -p 5080:5080 – Expose port 5080 for web UI
• -e ZO_ROOT_USER_EMAIL – Set login email
• -e ZO_ROOT_USER_PASSWORD – Set login password
• -e ZO_COMPACT_DATA_RETENTION_DAYS=3 – Keep data for 3 days
• -e ZO_ORG_DATA_QUOTA=10737418240 – 10GB organization quota
• -e ZO_STREAM_DATA_QUOTA=2147483648 – 2GB per stream quota

Step 2: Verify OpenObserve is Running

# Check container status
docker ps | grep openobserve

# View logs
docker logs -f openobserve

Once running, access OpenObserve at: http://localhost:5080

Step 3: Configure Wake to use OpenObserve

wake setconfig web.endpoint "http://localhost:5080"
wake setconfig web.user "root@example.com"
wake setconfig web.password "Complexpass#123"

Step 4: Send Logs to Web View

# Send all logs from "my-app" pod containing "error"
wake "my-app" -i "error" --web

# Send all logs from all pods in production namespace
wake -n production -A --web

# Send logs and save to file simultaneously
wake "my-app" --web -w /tmp/logs.txt

📌 Note: Stream names are auto-generated daily (e.g., logs_wake_{namespace}_2025_11_30). Logs appear in OpenObserve UI immediately.

🔍 Show Web View Screenshot

Wake supports advanced filtering to help you find exactly what you need.

# Include logs that contain "error" OR "warn"
wake "my-app" -i '"error" || "warn"'

# Exclude logs that contain "debug"
wake "my-app" -e "debug"

# Complex query: (error OR warn)
wake "my-app" -i '"error" || "warn"'

Wake provides two powerful ways to execute scripts on your Kubernetes pods: quick one-time execution with external script files, and a full-featured Script Manager TUI to create, save, edit, and reuse scripts stored inside Wake.

Option 1: Quick Script Execution (--script-in)

Run any external script file directly on pods. Best for one-time execution or scripts you don't need to save.

Run Script on Specific Pod

# Run a health check script on a specific pod
wake "my-app" --script-in ./scripts/check_health.sh --script-outdir /tmp/results

Run Script on All Matching Pods

# Run script on all pods matching a pattern across all namespaces
wake -A "worker-.*" --script-in ./scripts/diagnostics.sh --script-outdir /tmp/diag

Option 2: Script Manager TUI (--scripts) Beta

Create, save, edit, and reuse scripts stored inside Wake. Full TUI editor with argument support!

Open Script Manager

# Open the interactive script selector
wake --scripts

# Create a new script directly
wake --scripts New

# List all saved scripts (view/edit/delete/execute)
wake --scripts ALL

# Execute a specific saved script
wake --scripts my_health_check

# Execute script on matching pods
wake "app-.*" -n production --scripts my_health_check

Script Manager Features

• 📝 Built-in TUI Editor - Write and edit scripts with a full-featured terminal editor
• 🔧 Parameterized Arguments - Define reusable arguments with defaults (e.g., \${LOG_PATH}, \${TIMEOUT})
• 💾 Persistent Storage - Scripts saved in ~/.config/wake/scripts/ as TOML files
• 🚀 Multi-Pod Execution - Execute on multiple pods with live progress tracking
• 📊 Output Management - Save results as merged file or per-pod files

Script Editor Keyboard Shortcuts

Arguments Panel Keys

Script Execution Workflow

Scripts Feature Gallery

Browse through the complete scripts workflow with our interactive slideshow:

1. Script Selector - Choose to create a new script, view all scripts, or select an existing one

2. Script Name Input - Enter a name for your new script

3. Editor Selection - Choose between Wake's built-in TUI editor or your system editor

4. Script Editor - Write your script with the built-in TUI editor. Add arguments in the right panel.

5. Script List - View all saved scripts. Edit, execute, or delete them.

6. Script Selection - Select a saved script to execute from the list

7. Argument Input - Enter values for script arguments before execution

8. Execution Progress - Watch live progress as scripts execute on each pod

9. Execution Complete - View final results with success/failure status for each pod

❮ ❯

Click arrows or indicators to navigate • 1 of 9

Customize Wake's behavior through configuration commands.

# Open an interactive UI to edit all settings
wake setconfig

# Show all current configuration
wake getconfig

# Get a specific configuration key
wake getconfig web.endpoint

🔍 Show Configuration Screenshot

This image shows how the settings / configuration screen looks.

Wake saves your command history and allows you to search it using TF-IDF for intelligent retrieval.

# Search for commands related to "error logs"
wake --his "error logs"

# Show all command history
wake --his

Example: wake --his jfr

Example: wake --his jfr

Keep Wake up to date with the latest features and improvements.

Versioning

Wake follows semantic versioning: MAJOR.MINOR.PATCH.

• MAJOR — incompatible API or behaviour changes (breaking changes).
• MINOR — new features, backwards-compatible.
• PATCH — bug fixes and small improvements, backwards-compatible.

Examples: 1.2.0 → new features since 1.1.x; 2.0.0 → breaking changes from 1.x.

Check the Wake version locally:

wake --version
# or
wake -V

Update via Homebrew (macOS)

Update the Homebrew package on macOS:

brew upgrade samba-rgb/wake/wake

Update from Source

If you installed from source, update and re-run:

cd wake
git pull origin main   # or the branch you track
cargo run              # run latest changes

# Or rebuild release
cargo build --release
./target/release/wake --help

If you encounter any issues, please raise them on the GitHub Issues page.
For direct contact, you can reach the author at samba24052001@gmail.com.

If you like the application, please consider giving it a star on GitHub — it really helps the project: Star Wake on GitHub ⭐