The official CLI tool for deploying static sites to Walrus decentralized storage.
Deploy your Hugo sites to the decentralized web with an interactive wizard. No blockchain experience required.

---

Table of Contents

• Features
• Installation
• Quick Start
• Commands
• Configuration
• Documentation
• Requirements
• Troubleshooting
• Contributing
• About
• License

---

Features

Feature	Description
Interactive Deployment	walgo launch guides you step-by-step through the entire deployment process
Project Management	Track all your sites, deployment history, and updates with walgo projects
AI Content Generation	Generate and update blog posts with AI assistance
Free Testing Mode	HTTP deployment requires no wallet or cryptocurrency
Asset Optimization	Automatic HTML, CSS, and JavaScript minification
Brotli Compression	Pre-compressed files for faster load times
Obsidian Integration	One-command site creation from Obsidian vaults
Desktop App	Optional GUI for visual project management
SuiNS Support	Custom domain names via Sui Name Service

---

Installation

Quick Install (Recommended)

macOS/Linux:

# Prerequisites: Install Git first
# macOS: brew install git
# Ubuntu/Debian: sudo apt install git
# Fedora: sudo dnf install git
# Arch: sudo pacman -S git

curl -fsSL https://raw.githubusercontent.com/selimozten/walgo/main/install.sh | bash

Windows:

# Prerequisites: Install Git first
# Using Chocolatey (recommended):
# choco install git
# Or download from: https://git-scm.com/download/win

irm https://raw.githubusercontent.com/selimozten/walgo/main/install.ps1 | iex

Or download the binary manually from the releases page.

🪟 Windows Installation Details (Click to Expand)

Method 1: PowerShell One-Line Install (Recommended)

irm https://raw.githubusercontent.com/selimozten/walgo/main/install.ps1 | iex

This automatically detects your architecture, downloads binary, and installs it.

Method 2: Download and Install Manually

1. Download from releases page:

   • walgo-windows-amd64.exe (64-bit)
   • walgo-windows-arm64.exe (ARM64)

2. Add to PATH (PowerShell as Administrator):

   New-Item -ItemType Directory -Force -Path "C:\Program Files\walgo"
   Move-Item walgo.exe "C:\Program Files\walgo\"
   [Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\walgo", "Machine")

3. Important: Close and reopen terminal for PATH changes to take effect.

Common Windows Issues

"execution of scripts is disabled"

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Windows Defender SmartScreen warning

1. Click "More info"
2. Click "Run anyway"
3. Safe to run - source code is verified on GitHub

For complete Windows installation guide, see docs/INSTALLATION.md.

Using Go

go install github.com/selimozten/walgo@latest

Build from Source

git clone https://github.com/selimozten/walgo.git
cd walgo
make build

Verify Installation

walgo version

Desktop App (Optional)

Download the desktop GUI from the releases page.

macOS Installation

Security Note: The desktop app is currently not signed with an Apple Developer certificate. You'll need to allow it manually on first launch.

Method 1: Right-click to Open (Recommended)

1. Download and extract walgo-desktop_*_darwin_*.tar.gz
2. Move Walgo.app to your Applications folder
3. Right-click on Walgo.app and select "Open"
4. Click "Open" again in the security dialog
5. The app will now open and be trusted for future launches

Method 2: System Settings

1. Try to open the app normally (it will be blocked)
2. Go to System Settings → Privacy & Security
3. Scroll down and click "Open Anyway" next to the Walgo message
4. Click "Open" in the confirmation dialog

Method 3: Terminal (Advanced Users)

# Remove quarantine attribute
xattr -cr /Applications/Walgo.app

# Then open normally
open /Applications/Walgo.app

Why is this needed? Apple requires apps to be signed with a paid Developer ID certificate ($99/year). As an open-source project, we currently distribute unsigned builds. This is safe - you can verify the source code on GitHub.

Windows Installation

1. Download walgo-desktop_*_windows_amd64.zip
2. Extract and run walgo-desktop.exe
3. Windows Defender may show a warning - click "More info" → "Run anyway"

Linux Installation

1. Download walgo-desktop_*_linux_amd64.tar.gz
2. Extract and run ./walgo-desktop
3. Make executable if needed: chmod +x walgo-desktop

---

Quick Start

Option 1: Quickstart Command (Fastest)

Create, build, and deploy a new site in one command:

walgo quickstart my-blog

This will:

1. Create a new Hugo site with a theme
2. Add sample content
3. Build and optimize the site
4. Offer deployment options

Option 2: Step-by-Step Setup

# 1. Create a new site
walgo init my-site
cd my-site

# 2. Build your site
walgo build

# 3. Deploy with the interactive wizard
walgo launch

The Launch Wizard

walgo launch is the recommended way to deploy. It guides you through:

1. Network Selection — Choose testnet or mainnet
2. Wallet Setup — View balance, switch or create addresses
3. Project Details — Name your project for easy management
4. Storage Duration — Set how long to store your site (epochs)
5. Cost Review — See estimated gas fees before confirming
6. Deployment — Upload to Walrus with progress feedback
7. SuiNS Setup — Instructions to configure your custom domain

cd my-site
walgo launch

---

Commands

Core Workflow

Command	Description
walgo quickstart <name>	Create, build, and deploy a new site
walgo init <name>	Initialize a new Hugo site
walgo build	Build site with optimization
walgo serve	Start local development server
walgo launch	Interactive deployment wizard (recommended)

Project Management

Command	Description
walgo projects	List all your deployed sites
walgo projects show <name>	View project details and history
walgo projects update <name>	Update an existing deployment
walgo projects archive <name>	Archive a project

Content & AI

Command	Description
walgo new <path>	Create new content file
walgo import <vault>	Create site and import from Obsidian vault
walgo ai configure	Set up AI provider (OpenAI/OpenRouter)
walgo ai generate	Generate content with AI
walgo ai update <file>	Update content with AI

Utilities

Command	Description
walgo doctor	Diagnose environment issues
walgo status <id>	Check deployment status
walgo optimize	Optimize HTML/CSS/JS files
walgo compress	Apply Brotli compression
walgo domain	SuiNS domain management

Advanced Deployment

Command	Description
walgo deploy	Direct on-chain deployment (requires wallet)
walgo deploy-http	HTTP deployment (no wallet, testnet only)
walgo update <id>	Update existing site by object ID

Note: For most users, walgo launch is the recommended deployment method as it provides guidance and manages your projects automatically.

---

Configuration

Walgo uses a walgo.yaml configuration file in your project directory:

# Hugo settings
hugo:
  publishDir: "public"
  contentDir: "content"
  build_draft: false
  minify: true

# Walrus deployment settings
walrus:
  project_id: "" # Set automatically after first deploy
  epochs: 5 # Storage duration
  entrypoint: "index.html"

# Asset optimization
optimizer:
  enabled: true
  html:
    enabled: true
    minify_whitespace: true
    remove_comments: true
  css:
    enabled: true
    minify: true
  js:
    enabled: true
    minify: true

# Brotli compression
compress:
  enabled: true
  brotli_level: 6

# AI content generation (optional)
ai:
  enabled: false
  provider: "openai" # or "openrouter"
  model: "gpt-4"

# Obsidian import settings (optional)
obsidian:
  vault_path: ""
  include_drafts: false
  convert_wikilinks: true

Environment Variables

Variable	Description
WALGO_ASCII=1	Force ASCII output (no emojis)
WALGO_EMOJI=1	Force emoji output

---

Documentation

Comprehensive documentation is available in the docs/ directory:

Getting Started

• Quickstart Guide — Deploy in 2 minutes
• Installation Guide — All platforms
• Getting Started — First deployment walkthrough

User Guides

• Commands Reference — All 29+ commands documented
• Launch Wizard — Interactive deployment guide
• Configuration — All options explained
• Deployment Guide — HTTP vs on-chain deployment
• AI Features — Content generation with AI
• Troubleshooting — Common issues

Developer Guides

• Architecture — System design
• Development — Contributing setup
• Contributing — How to contribute

---

Requirements

Required

• Git — Version control system (required for installation and some features)

  # macOS
  brew install git
  
  # Ubuntu/Debian
  sudo apt install git
  
  # Fedora
  sudo dnf install git
  
  # Windows (Chocolatey)
  choco install git
  
  # Windows (Scoop)
  scoop install git
  
  # Or download from https://git-scm.com

• Hugo Extended — Static site generator

  Important: The Extended version is required for SCSS/SASS support.

  # macOS
  brew install hugo
  
  # Ubuntu/Debian
  sudo apt install hugo
  
  # Fedora
  sudo dnf install hugo
  
  # Windows (Chocolatey)
  choco install hugo-extended
  
  # Windows (Scoop)
  scoop install hugo-extended
  
  # Verify it's the extended version
  hugo version  # Should show "extended"

For On-Chain Deployment

• site-builder — Walrus Sites CLI

  walgo setup-deps  # Installs automatically

• Sui Wallet — With SUI tokens

  # Set up wallet for testnet
  walgo setup --network testnet

Optional

• Obsidian — For vault import feature
• OpenAI/OpenRouter API Key — For AI content generation

---

Troubleshooting

Quick Diagnostics

walgo doctor           # Check your setup
walgo doctor -v        # Verbose diagnostics
walgo doctor --fix-all # Auto-fix common issues

Common Issues

Issue	Solution
site-builder not found	Run walgo setup-deps
insufficient funds	Get testnet SUI from faucet
Hugo not extended	Reinstall Hugo Extended version
network timeout	Retry with --epochs 1 or check connectivity

Getting Help

• Documentation: docs/TROUBLESHOOTING.md
• GitHub Issues: Report a bug
• GitHub Discussions: Ask questions
• Feedback Form: Submit feedback

---

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

Development Setup

# Clone the repository
git clone https://github.com/selimozten/walgo.git
cd walgo

# Install dependencies and build
make build

# Run tests
make test

# Run linter
make lint

Project Structure

walgo/
├── cmd/           # CLI commands
├── internal/      # Internal packages
│   ├── ai/        # AI content generation
│   ├── cache/     # Deployment caching
│   ├── compress/  # Brotli compression
│   ├── config/    # Configuration management
│   ├── deployer/  # Deployment adapters
│   ├── hugo/      # Hugo integration
│   ├── launch/    # Launch wizard
│   ├── obsidian/  # Obsidian import
│   ├── optimizer/ # Asset optimization
│   ├── projects/  # Project management
│   ├── ui/        # Terminal UI helpers
│   └── walrus/    # Walrus CLI wrapper
├── docs/          # Documentation
├── desktop/       # Desktop app (Wails)
└── tests/         # Integration tests

---

About

Walgo is developed by the Ganbitera team as a winner of the Walrus RFP (Request for Proposals) for developer tooling.

Why Walgo?

• Simple — One command to deploy: walgo launch
• Guided — Interactive wizard for beginners
• Powerful — Project management, AI content, optimization
• Flexible — Free HTTP testing or permanent on-chain storage
• Official — Supported by the Walrus ecosystem

What is Walrus?

Walrus is a decentralized storage network built on Sui that enables permanent, censorship-resistant hosting of websites and applications.

Links

• Walrus Documentation: docs.walrus.site
• Sui Documentation: docs.sui.io
• SuiNS (Domains): suins.io | Tutorial

---

License

MIT License — See LICENSE for details.

---