🚀 Getting Started
Welcome aboard, future Rust captain! Cargo Mate is your first mate for navigating the complex world of Rust development. Whether you're a seasoned developer or just starting your Rust journey, Cargo Mate helps you stay organized, recover from mistakes, and ship code faster.
🎬 Journey Recording
Record and replay your command sequences. Never lose track of what you did to fix that bug or implement that feature.
⚓ Anchor Points
Save project states instantly before risky operations. Restore your project with one command if things go wrong.
📜 Captain's Log
Keep detailed notes and observations about your development process. Your project's narrative history.
📦 Installation
Getting Cargo Mate installed is as easy as setting sail on a calm day.
Download
Visit the download page and grab the latest version for your platform:
# Download for your platform
curl -L https://cargo.do/download/latest/linux -o cargo-mate
chmod +x cargo-mate
sudo mv cargo-mate /usr/local/bin/cm
Verify Installation
$ cm --version
🦀 Cargo Mate v1.0.0 - Your First Mate for Rust Development
Free vs Pro
💡 Tip: The free version includes all features with a 10-command daily limit. Upgrade to Pro for unlimited usage and additional features.
⚡ Commands Overview
Cargo Mate comes with 40+ powerful commands to enhance your Rust development workflow.
cm journey record
Start recording a new journey to capture your development session
cm journey record my-feature-work
cm journey replay
Replay a previously recorded journey
cm journey replay my-feature-work
cm anchor save
Save current project state as an anchor point
cm anchor save before-refactor
cm anchor restore
Restore project to a saved anchor point
cm anchor restore before-refactor
cm log add
Add an entry to your captain's log
cm log add "Fixed compilation error in module X"
cm optimize
Run optimization routines on your project PRO
cm optimize aggressive
cm view checklist
View your current development checklist
cm view checklist
cm mutiny
Enter YOLO mode for risky operations PRO
cm mutiny yolo
🎬 Journey Recording
Journeys are Cargo Mate's most powerful feature. They record everything you do during a development session, allowing you to replay, share, and learn from your process.
Recording a Journey
# Start recording
$ cm journey record fixing-memory-leak
🎬 Recording journey "fixing-memory-leak"...
All your commands will be captured!
# Do your work
$ cargo build
$ cargo test
$ cargo clippy
# Stop recording
$ cm journey stop
⚓ Journey saved! 15 commands recorded.
Replaying Journeys
# Replay a journey
$ cm journey replay fixing-memory-leak
🎬 Replaying journey "fixing-memory-leak"...
This will execute all 15 commands. Continue? (y/N)
# Replay with modifications
$ cm journey replay fixing-memory-leak --dry-run
Managing Journeys
# List all journeys
$ cm journey list
# Delete a journey
$ cm journey delete old-journey
# Share a journey (Pro feature)
$ cm journey publish fixing-memory-leak --public
🔗 Shareable link: https://cargo.do/journey/abc123
⚓ Anchor Points
Anchor points are like git commits but for your entire project state. Save before risky operations and restore instantly if needed.
Creating Anchors
# Save current state
$ cm anchor save before-refactor
⚓ Anchor "before-refactor" saved!
- Code: 1,247 files
- Dependencies: Cargo.lock
- Environment: All configs
# Save with description
$ cm anchor save major-changes --desc "Before API redesign"
Restoring from Anchors
# List available anchors
$ cm anchor list
# Restore to an anchor
$ cm anchor restore before-refactor
⚓ Restoring to "before-refactor"...
This will overwrite current files. Continue? (y/N)
# Preview what will change
$ cm anchor diff before-refactor
🚀 Pro Features
Upgrade to Cargo Mate Pro for unlimited usage and exclusive features.
⚡ Unlimited Commands
No more daily limits. Use Cargo Mate as much as you need for professional development.
☁️ Cloud Sync
Sync your journeys, anchors, and logs across all your devices automatically.
🤖 AI Assistant
Get intelligent suggestions and help with error resolution powered by AI.
👥 Team Features
Share journeys and anchors with your team for better collaboration.
Getting Pro Access
# After purchasing Pro
$ cm register YOUR_LICENSE_KEY
🦀 Welcome to Cargo Mate Pro!
Unlimited commands activated!
# Check your Pro status
$ cm status
🔧 Troubleshooting
Common Issues
Command not found after installation
# Make sure Cargo Mate is in your PATH
$ which cm
/usr/local/bin/cm
# If not found, add to PATH
$ export PATH=$PATH:/usr/local/bin
Permission denied
# Fix permissions
$ chmod +x /usr/local/bin/cm
# Or run with sudo for system installation
$ sudo cp cm /usr/local/bin/
Daily limit reached
💡 Solution: Upgrade to Pro for unlimited commands or wait until tomorrow for your free commands to reset.
Getting Help
If you're still having issues:
🔌 API Reference
Cargo Mate also provides a REST API for integrations and automation.
Authentication
# All API requests require authentication
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.cargo.do/v1/journeys
Endpoints
List Journeys
GET /api/v1/journeys
Response:
{
"journeys": [
{
"id": "abc123",
"name": "fix-memory-leak",
"commands": 15,
"created_at": "2024-01-15T10:30:00Z"
}
]
}
Create Journey
POST /api/v1/journeys
{
"name": "new-feature",
"description": "Working on user authentication"
}