Quick Reference - webatui Automation

Fast lookup for common commands and workflows.

๐Ÿš€ Quick Start

just                    # Show all commands
just build-wasm         # Build WASM
just serve              # Serve locally on :8080
just dev                # Run dev workflow (fmt, lint, test)
just deploy             # Deploy to GitHub Pages

๐Ÿ“ฆ Build

just build              # Debug build
just build-release      # Release build
just build-wasm         # WASM build
just build-wasm-release # WASM release (optimized)

๐Ÿงช Test

just test               # Run tests
just test-all           # Run tests (verbose)
just test-coverage      # Generate coverage
just watch-test         # Watch and test

๐Ÿ” Check & Lint

just check              # Cargo check
just fmt                # Format code
just fmt-check          # Check formatting
just lint               # Run clippy
just lint-strict        # Strict clippy

๐Ÿงน Clean

just clean              # Clean build artifacts
just clean-wasm         # Clean WASM
just clean-all          # Deep clean

๐ŸŒ Serve & Deploy

just serve              # Serve on :8080
just serve 3000         # Serve on :3000
just deploy             # Deploy to GitHub Pages

๐Ÿ‘€ Watch

just watch              # Watch and rebuild
just watch-test         # Watch and test
just watch-wasm         # Watch WASM

๐Ÿ“š Documentation

just docs               # Build docs
just docs-open          # Build and open docs

๐Ÿ“Š Info & Stats

just info               # Tool versions
just stats              # Project stats
just status             # Git & dependencies status
just deps               # Dependency tree

๐Ÿ”ง Workflows

just dev                # fmt โ†’ lint โ†’ test
just prod               # fmt-check โ†’ lint-strict โ†’ test โ†’ build-release
just ci                 # All CI checks
just dev-wasm           # WASM development workflow

๐ŸŽฏ Common Patterns

Development Iteration

# Terminal 1: Auto-rebuild
just watch
 
# Terminal 2: Serve with auto-reload
just serve --open

WASM Development

just build-wasm-release # Build
just serve 8080         # Serve
just deploy             # Deploy

Before Commit

just dev                # Full dev workflow
# or
just fmt && just lint && just test

Production Release

just prod               # Full production workflow
# or
just fmt-check && just lint-strict && just test-all && just build-release

๐Ÿ› ๏ธ Nushell Scripts (Advanced)

Build with Options

nu scripts/build.nu --wasm --pack --release --optimize
nu scripts/build.nu --target x86_64-pc-windows-gnu --release

Serve with Options

nu scripts/serve.nu --port 3000 --open --cors --spa
nu scripts/serve.nu --dir www --host localhost

Deploy with Options

nu scripts/deploy.nu --target netlify
nu scripts/deploy.nu --dry-run
nu scripts/deploy.nu --branch main --message "v1.0.0"

Test with Options

nu scripts/test.nu --coverage
nu scripts/test.nu --wasm
nu scripts/test.nu --filter my_test --nocapture

Clean with Options

nu scripts/clean.nu --all --dry-run
nu scripts/clean.nu --cargo --wasm
nu scripts/clean.nu --temp

๐Ÿ“‹ Installation

# Install task runner
brew install just       # macOS
cargo install just      # Cross-platform
 
# Install nushell
brew install nushell    # macOS
cargo install nu        # Cross-platform
 
# Install project tools
just install-all

๐Ÿ”‘ Key Files

FilePurpose
justfileHigh-level task automation
scripts/build.nuBuild automation
scripts/serve.nuHTTP server for WASM
scripts/deploy.nuDeployment automation
scripts/test.nuTest runner
scripts/clean.nuCleanup automation
docs/AUTOMATION.mdFull documentation
scripts/README.mdScripts documentation

๐Ÿ’ก Tips

  • Use just for quick tasks
  • Use nu scripts/*.nu --help for advanced options
  • Run just dev before committing
  • Use --dry-run for preview (deploy, clean)
  • Enable watch mode during development
  • Check just --list for all commands

๐Ÿ†˜ Help

just --list             # List all just commands
just help               # Show help with descriptions
nu scripts/build.nu --help    # Build script help
nu scripts/serve.nu --help    # Serve script help
nu scripts/deploy.nu --help   # Deploy script help
nu scripts/test.nu --help     # Test script help
nu scripts/clean.nu --help    # Clean script help

๐Ÿ“– Full Documentation

๐ŸŽจ Color Output

All scripts provide colorful output:

  • ๐ŸŸข Green: Success
  • ๐Ÿ”ต Blue: Information
  • ๐ŸŸก Yellow: Warnings
  • ๐Ÿ”ด Red: Errors
  • ๐Ÿ”ท Cyan: Steps
  • ๐ŸŸฃ Purple: Commands

Pro Tip: Add this to your shell aliases:

# ~/.bashrc or ~/.zshrc
alias jb='just build'
alias jt='just test'
alias js='just serve'
alias jd='just deploy'
alias jw='just watch'