Scout CLI

A modern, intuitive alternative to ls and cd commands with smart directory prediction.

Installation

1. Install via pip:

pip install scout-cli

2. Set up shell integration:

# Add to your ~/.bashrc or ~/.zshrc:
source "$(pip show scout-cli | grep Location | cut -d' ' -f2)/scout/share/scout/scout.sh"

Features

• Smart directory navigation with fuzzy matching
• Modern, colorful file listings
• Bookmark management for frequently used directories
• AI-powered directory suggestions
• Project root detection
• Time-based suggestions

Usage

List Files (replaces ls)

scout                    # List files in current directory
scout -a                 # Show hidden files
scout --sort size       # Sort by file size
scout --sort modified   # Sort by modification time
scout --sort name       # Sort by name (default)

Directory Navigation (replaces cd)

scout jump <dir>        # Smart jump to directory
scout jump -            # Go back to previous directory
scout jump docs -c      # Create 'docs' directory and jump to it
scout jump old-dir -d   # Delete directory (with confirmation)
scout jump old-dir -d -f # Force delete without confirmation

Bookmark Management

scout jump --save       # Save current directory as bookmark
scout jump --bookmarks  # List saved bookmarks
scout jump <bookmark>   # Jump to bookmarked directory

Smart Features

• Fuzzy Matching: Type partial names, scout finds matches
• AI Suggestions: Scout learns from your navigation patterns
• Context Aware: Suggests based on time and location
• Project Detection: Recognizes project directories

Development

1. Clone the repository
2. Install development dependencies:

make dev-setup

3. Run tests:

make test

4. Build and install locally:

make install

License

MIT License