CLI Overview The Stardust CLI is a powerful command-line interface bundled with the desktop app. It’s designed for developers and power users who prefer working in the terminal.
Why Use the CLI?
Stay in Flow Create and manage tasks without leaving your terminal. No context switching.
Fast Operations Rust-powered core for instant response times. Zero external dependencies.
Scriptable Integrate task management into your shell scripts and automation workflows.
Git Integration Built-in git operations without requiring system git.
Getting Started Verify Installation After installing the desktop app , verify the CLI is available:
You should see:
Stardust CLI v1.0.0 Features: git, cache, file-ops
Core Commands Task Management Create, list, and manage your tasks from the terminal:
# Create a new task stardust task create "Review the API documentation" # List your tasks stardust tasks ready # Start working on a task stardust task start tk-001 # Mark a task as done stardust task done tk-001
AI Triage Let Stardust’s AI help you prioritize:
# Get AI-powered priority recommendations stardust tasks prioritize # See what to work on next stardust tasks next
Quick Capture Capture tasks without leaving your workflow:
# Quick add with natural language stardust add "Follow up with Sarah after her PTO" # Add with priority stardust add "Fix auth bug" --priority high
The CLI includes powerful tools for developers:
Git Operations Built-in git operations powered by gitoxide (no system git required):
# Check repository status stardust git status . # View recent commits stardust git log . --count 10
File Search Fast file and content search:
# Find files by pattern stardust file find "*.py" --path ./src # Search content (ripgrep-like) stardust file grep "TODO" --files "*.ts" # Count lines of code stardust file loc --path ./src
Caching Manage the CLI’s cache for faster operations:
# View cache info stardust cache info # Clear cache stardust cache clear
Human-Readable (Default) Ready Tasks (3) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ │ ID │ Title │ Priority │ │────────│──────────────────────│──────────│ │ tk-001 │ Review API docs │ high │ │ tk-002 │ Fix auth bug │ critical │ │ tk-003 │ Update tests │ medium │
JSON (Scriptable) stardust tasks ready --json
[ { "id" : "tk-001" , "title" : "Review API docs" , "priority" : "high" }, { "id" : "tk-002" , "title" : "Fix auth bug" , "priority" : "critical" }, { "id" : "tk-003" , "title" : "Update tests" , "priority" : "medium" } ]
Shell Integration Aliases Add these to your .zshrc or .bashrc for quick access:
# Quick task aliases alias ta = "stardust task create" alias tl = "stardust tasks ready --owner @me" alias tp = "stardust tasks prioritize" alias td = "stardust task done" # Start your day alias morning = "stardust tasks ready --owner @me --priority high,critical"
Completions Enable tab completion for faster command entry:
# For zsh stardust --install-completion zsh # For bash stardust --install-completion bash
Help System Get help for any command:
# Global help stardust --help # Command group help stardust tasks --help # Specific command help stardust task create --help
Error Codes The CLI uses standard exit codes:
Code Meaning 0Success 1General error 2Invalid usage
The CLI is optimized for speed:
Operation Time git status~10ms tasks ready~50ms file grep~100ms
The CLI uses Rust for performance-critical operations, making it faster than traditional shell scripts.
Next Steps 