WALRUS STARTER KIT

Modern CLI for scaffolding decentralized storage dApps on Sui.

v2.0.4-beta
terminal CLI_COMMAND
npm
$ npm create walrus-app@latest my-app
bolt WIZARD INTERACTIVE
Start setup wizard START
menu_book DOCS
Read documentation arrow_outward

Buy WAL

TESTNET
Balance: -- SUI
SUI

Connect wallet above to swap SUI for WAL

Zero Config Setup

Skip the build engineering. We handle the TypeScript chaos so you can focus on building storage dApps.

terminal

One Command

Initialize the entire stack with a single npx command.

settings_suggest

No TSConfig Tweaking

Pre-configured strict mode, path aliases, and build targets.

timer

< 5 Min to Dev Server

From zero to localhost:5173 with HMR enabled.

Battle-Tested Metrics

Manual Setup 4+ Hours
Walrus Starter Kit < 5 Minutes
40%
Smaller Project Size
97.5%
Test Coverage

Modular Layer System

Architecture designed for scale and replaceability.

LAYER 04

Use Case

Gallery / Upload / Share
arrow_downward
LAYER 03

Framework

React / Vue / Svelte
arrow_downward
LAYER 02

SDK Adapters

Type-Safe Interfaces
arrow_downward
LAYER 01

Base

Walrus Network / Sui

SDK-Agnostic Adapter Pattern

Switch between local simulation and mainnet storage without changing your UI code.

interfaces/StorageAdapter.ts 
export interface StorageAdapter {
  // Upload a file and get a blob ID
  upload(file: File): Promise<string>;
  // Retrieve file info metadata
  getInfo(id: string): Promise<BlobMetadata>;
  // Download blob content
  download(id: string): Promise<Blob>;
  // Remove from local tracking
  delete(id: string): Promise<void>;
}
check_circle Strict Mode
check_circle Type-Safe Interfaces

Developer-First DX

Feature Benefit
bolt Interactive Wizard Step-by-step CLI configuration, no manual copy-paste.
science Atomic Gen Components are generated as independent, removable atoms.
policy MIT License Full ownership of your scaffolded code. Commercial ready.
rocket_launch Production Auto Auto-installs dependencies, git init, & Sui Wallet integration.

Core Features

Everything you need to build production-ready Walrus dApps.

layers
layers

Interactive CLI Wizard

Forget boilerplate. Answer a few questions and get a fully configured project with routing, state management, and wallet adapters.

? Select framework:
> React
  Vue
  Svelte
extension
extension

Storage Adapter Pattern

Switch between local simulation and mainnet storage without changing your UI code. Type-safe interfaces for all operations.

interface StorageAdapter {
  upload(file: File): Promise<string>
}
deployed_code
deployed_code

Templates Showcase

Start with best practices. Includes pre-built components for file uploads, gallery views, and encryption.

  • ✓ Image Gallery
  • ✓ Drag & Drop Zone
  • ✓ Encryption/Decryption

INITIALIZE_SEQUENCE

01. Install CLI

Install the creator via npx.

npx @blu1606/create-walrus-app content_copy

02. Scaffold Project

Interactive setup with 6 customized prompts.

npx @blu1606/create-walrus-app my-walrus-app content_copy

03. Start Dev Server

Launches app at localhost:5173

cd my-walrus-app && npm run dev play_arrow