Skip to content

hien-p/raycast-sui-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sui CLI Web

A keyboard-first web interface for First Movers building on Sui. Manage addresses, switch environments, request faucet tokens, and more - all from a beautiful web UI designed for power users.

License npm Node

Live: https://www.harriweb3.dev | NPM: sui-cli-web-server

Features

  • Address Management - View, switch, create addresses with balance display
  • Transfer SUI - Send SUI tokens with gas estimation
  • Gas Management - Split and merge gas coins
  • Environment Switching - Switch between mainnet, testnet, devnet, localnet
  • Faucet Integration - Request test tokens directly from the UI
  • Move Development - Build, test, publish, upgrade packages
  • Community Tiers - Join on-chain community with tier progression
  • Transaction Inspector - Inspect and replay transactions

Architecture

┌─────────────────────────────────────────────────────────────────┐
│                         Web Browser                              │
│  ┌─────────────────────────────────────────────────────────┐    │
│  │              React Web UI (Vercel)                       │    │
│  │            https://www.harriweb3.dev                     │    │
│  └─────────────────────────────────────────────────────────┘    │
└─────────────────────────────────────────────────────────────────┘
                              │
                              │ HTTP (localhost:3001)
                              ▼
┌─────────────────────────────────────────────────────────────────┐
│                      Your Local Machine                          │
│  ┌─────────────────────────────────────────────────────────┐    │
│  │              Local Server (Fastify)                      │    │
│  │                 npx sui-cli-web-server                          │    │
│  └─────────────────────────────────────────────────────────┘    │
│                              │                                   │
│                              │ executes                          │
│                              ▼                                   │
│  ┌─────────────────────────────────────────────────────────┐    │
│  │                    Sui CLI                               │    │
│  │              ~/.sui/sui_config/client.yaml              │    │
│  └─────────────────────────────────────────────────────────┘    │
└─────────────────────────────────────────────────────────────────┘

Your keys stay on YOUR machine. Private keys never leave your local Sui CLI.

Quick Start

Prerequisites

# Install Sui CLI
brew install sui                    # macOS (Homebrew)
cargo install --locked sui          # All platforms (Rust)

Run

npx sui-cli-web

Then open: https://www.harriweb3.dev

Run from Source

git clone https://github.com/hien-p/raycast-sui-cli.git
cd raycast-sui-cli
npm install
npm run dev

Documentation

Document Description
Getting Started Quick start guide and installation
User Guide Complete user documentation
Features Feature inventory & implementation status
Troubleshooting Common issues & solutions
Server API Server package documentation
Smart Contract Community registry contract details

Development

npm run dev           # Run both client & server
npm run dev:server    # Server only (port 3001)
npm run dev:client    # Client only (port 5173)
npm run build         # Build all packages

Project Structure

packages/
├── client/     # React + Vite + TailwindCSS frontend
├── server/     # Fastify backend (npm: sui-cli-web-server)
└── shared/     # TypeScript types

Troubleshooting

Cannot connect to server?

npx sui-cli-web-server  # Make sure server is running

Sui CLI not found?

brew install sui          # macOS
cargo install --locked sui # All platforms

Port 3001 in use?

lsof -ti:3001 | xargs kill -9  # macOS/Linux

See docs/TROUBLESHOOTING.md for more.

Security

  • Server binds to localhost only - no external access
  • Private keys managed by local Sui CLI
  • All code is open source - audit it

Contributing

  1. Fork the repository
  2. Create feature branch (git checkout -b feature/amazing-feature)
  3. Commit changes (git commit -m 'Add amazing feature')
  4. Push to branch (git push origin feature/amazing-feature)
  5. Open Pull Request

License

MIT License - see LICENSE for details.

Links