Documentation

Getting Started

CLI Reference

API Reference

Installation

Vibe tools can be installed using Go's package manager or by downloading pre-compiled binaries.

go install github.com/gabrielalmir/vibe-glow/cmd/vibe-glow@latest

go install github.com/gabrielalmir/hush/cmd/vibe-hush@latest

Make sure your Go bin directory is in your PATH. You can check its location with go env GOPATH.

Basic Usage

Here's how to get started with Vibe tools after installation.

Vibe Glow

# Start the Glow service vibe-glow start # Check service status vibe-glow status # View logs in the terminal UI vibe-glow tui # Get help vibe-glow --help

Vibe Hush

# Start the Hush service vibe-hush start # Store data in cache vibe-hush set user-123 'name":"John Doe' --ttl=3600 # Retrieve data from cache vibe-hush get user-123 # Get help vibe-hush --help

Configuration

Vibe tools can be configured using configuration files or environment variables.

Configuration File

Create a config.yaml file in your project directory:

# Vibe Glow configuration glow: port: 8080 storage: type: sqlite path: ./logs.db log_level: info # Vibe Hush configuration hush: port: 8081 storage: type: sqlite path: ./cache.db ttl: 3600

Environment Variables

You can also configure Vibe tools using environment variables:

# Vibe Glow environment variablesexport VIBE_GLOW_PORT=8080export VIBE_GLOW_STORAGE_TYPE=sqliteexport VIBE_GLOW_STORAGE_PATH=./logs.dbexport VIBE_GLOW_LOG_LEVEL=info# Vibe Hush environment variablesexport VIBE_HUSH_PORT=8081export VIBE_HUSH_STORAGE_TYPE=sqliteexport VIBE_HUSH_STORAGE_PATH=./cache.dbexport VIBE_HUSH_DEFAULT_TTL=3600

Vibe Glow Commands

Complete reference for all Vibe Glow CLI commands.

Command	Description	Example
start	Start the Glow service	vibe-glow start
status	Check service status	vibe-glow status
tui	Launch terminal UI	vibe-glow tui
log	Send a log entry	vibe-glow log "User logged in"
metrics	View current metrics	vibe-glow metrics

Vibe Hush Commands

Complete reference for all Vibe Hush CLI commands.

Command	Description	Example
start	Start the Hush service	vibe-hush start
status	Check service status	vibe-hush status
set	Store data in cache	vibe-hush set key value --ttl=3600
get	Retrieve data from cache	vibe-hush get key
delete	Remove data from cache	vibe-hush delete key
flush	Clear all cached data	vibe-hush flush

Glow API Reference

REST API endpoints for Vibe Glow.

POST /log

Submit application logs

Request Body:

{
  "level": "info",
  "message": "User login successful",
  "service": "auth-service",
  "timestamp": "2023-06-15T14:22:10Z",
  "metadata": {
    "userId": "user-123",
    "ip": "192.168.1.1"
  }
}

Response:

{
  "status": "Log saved successfully"
}

GET /metrics

Retrieve system metrics

Response:

{
  "cpu": {
    "usage": 42.5,
    "cores": 8
  },
  "memory": {
    "total": 16384,
    "used": 8192,
    "percentage": 50.0
  },
  "logs": {
    "count": 1243,
    "by_level": {
      "info": 932,
      "warn": 186,
      "error": 125
    }
  }
}

Hush API Reference

REST API endpoints for Vibe Hush.

PUT /cache/:key

Store data in cache

Headers:

X-Cache-TTL: 3600

Request Body:

{
  "name": "John Doe",
  "email": "john@example.com",
  "preferences": {
    "theme": "dark",
    "notifications": true
  }
}

Response:

{
  "status": "ok"
}

GET /cache/:key

Retrieve data from cache

Response:

{
  "name": "John Doe",
  "email": "john@example.com",
  "preferences": {
    "theme": "dark",
    "notifications": true
  }
}

DELETE /cache/:key

Remove data from cache

Response:

{
  "status": "ok"
}