Cargo Mate
A Rust development companion that enhances cargo with intelligent workflows, state management, performance optimization, and comprehensive project monitoring.
Table of Contents
π Installation
Option 1: Universal Installer (Recommended - Works Everywhere)
|
β No compilation needed, auto-detects platform, handles all dependencies
Option 2: Direct Download - Choose Your Platform
# Linux x86_64
&&
# Linux ARM64
&&
# macOS Intel
&&
# macOS Apple Silicon
&&
# Windows
# Run install.ps1 in PowerShell
Option 3: From Source via Cargo (Requires Build Tools)
# Prerequisites: apt install build-essential (or equivalent)
&&
β οΈ Note: Requires C compiler/linker. If you get "linker cc not found", use Option 1 or 2 instead.
Troubleshooting
- "linker cc not found": Install build-essential first, or use the curl/wget installers
- "GLIBC_2.32 not found": Use the universal installer (Option 1) which auto-selects compatible version
- Behind firewall: Use Option 2 to download manually
Journey Commands
Anchor Commands
Log Commands
Tide Commands
Map Commands
Mutiny Commands
Config Commands
Version Commands
View Commands
Optimize Commands
General Commands
Journey Recording & Playback
Record your command sequences and replay them perfectly. Great for onboarding, CI/CD, and sharing workflows.
# ... do your work ...
# Ctrl+D to stop
β Anchor Points (with Auto-Update)
Save and restore complete project states, including Git commits, dependencies, and files. Now with automatic background updating that keeps your anchor current as you work!
Manual Mode:
# ... make changes ...
Auto-Update Mode:
# Start background auto-updating (recommended)
# Start foreground auto-updating (blocking)
# Files are automatically updated when you edit them!
# You'll see notifications like:
# [14:32:15] Updated src/main.rs in anchor 'my-project'
# Stop auto-update when done
Auto-Update Features:
- Real-time Updates: Files are saved to anchor immediately when changed
- Background Mode: Non-blocking, runs while you continue working
- Efficient: Only updates specifically modified files
- Smart Monitoring: Automatically watches relevant directories
- Easy Control: Simple start/stop commands
Captain's Log
Natural language build notes with automatic tagging and search.
π Tide Charts
Interactive performance tracking and build analytics.
Treasure Maps
Visualize and analyze your dependency tree.
Mutiny Mode
Override cargo's restrictions when you know what you're doing.
Auto-Versioning
Automatic version incrementing with semantic versioning support.
# Auto-increments on every build/check operation
Build Optimization
Automatically optimize your Cargo.toml for maximum build performance.
Smart Configuration
Project-local and global configuration with shortcuts and hooks.
Build Result Viewing
Comprehensive viewing of build results, artifacts, and generated files.
Smart Error Parsing
Transforms cargo errors into actionable checklists with fix suggestions.
π§ Do you prefer Quick & Dirty?
# Clone and build
|
Configuration
Project Configuration (.cg)
[]
= "my-project"
= "build"
= true
[]
= true
= "patch"
[]
= "build --release"
= "test --all"
Global Configuration (~/.shipwreck/config.toml)
[]
= true
= false
[]
= 4
= true
Some Examples
Development Workflow
# Save current state before major changes
# Record your development workflow
# Ctrl+D to stop recording
# Replay the workflow anytime
Performance Optimization
# Check optimization recommendations
# Apply balanced optimizations
# Monitor build performance
Version Management
# Initialize with semantic versioning
# Versions auto-increment on builds
# Manual version bump for releases
π’ Cargo Mate
- π’ Your project is a ship
- β Anchors save your position
- π Tide charts track the flow
- πΊοΈ Maps show the territory
- π΄ββ οΈ Mutiny overrides the captain
- π Captain's log records the journey
- π’ Auto-versioning keeps your ship on course
- π Build optimization gives you the wind in your sails
π License
This project is licensed
For more information, visit: cargo.do/license
Built with β€οΈ for the Rust community. No more shipwrecks in the sea of cargo errors!