| Name | scout-cli JSON |
| Version |
0.11.0
JSON |
| download |
| home_page | None |
| Summary | A modern, intuitive alternative to ls command with smart directory prediction |
| upload_time | 2025-01-08 18:41:30 |
| maintainer | None |
| docs_url | None |
| author | Andrew Wade |
| requires_python | >=3.7 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Scout CLI
A modern, intuitive alternative to `ls` and `cd` commands with smart directory prediction.
## Installation
1. Install via pip:
```bash
pip install scout-cli
```
2. Set up shell integration:
```bash
# 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)
```bash
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)
```bash
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
```bash
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:
```bash
make dev-setup
```
3. Run tests:
```bash
make test
```
4. Build and install locally:
```bash
make install
```
## License
MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "scout-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Andrew Wade",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/09/83/447eefcb93683ae221f3ba7804743a1a5914afef70e84258b7ddfdfea9b9/scout_cli-0.11.0.tar.gz",
"platform": null,
"description": "# Scout CLI\n\nA modern, intuitive alternative to `ls` and `cd` commands with smart directory prediction.\n\n## Installation\n\n1. Install via pip:\n```bash\npip install scout-cli\n```\n\n2. Set up shell integration:\n```bash\n# Add to your ~/.bashrc or ~/.zshrc:\nsource \"$(pip show scout-cli | grep Location | cut -d' ' -f2)/scout/share/scout/scout.sh\"\n```\n\n## Features\n\n- Smart directory navigation with fuzzy matching\n- Modern, colorful file listings\n- Bookmark management for frequently used directories\n- AI-powered directory suggestions\n- Project root detection\n- Time-based suggestions\n\n## Usage\n\n### List Files (replaces ls)\n```bash\nscout # List files in current directory\nscout -a # Show hidden files\nscout --sort size # Sort by file size\nscout --sort modified # Sort by modification time\nscout --sort name # Sort by name (default)\n```\n\n### Directory Navigation (replaces cd)\n```bash\nscout jump <dir> # Smart jump to directory\nscout jump - # Go back to previous directory\nscout jump docs -c # Create 'docs' directory and jump to it\nscout jump old-dir -d # Delete directory (with confirmation)\nscout jump old-dir -d -f # Force delete without confirmation\n```\n\n### Bookmark Management\n```bash\nscout jump --save # Save current directory as bookmark\nscout jump --bookmarks # List saved bookmarks\nscout jump <bookmark> # Jump to bookmarked directory\n```\n\n## Smart Features\n\n- **Fuzzy Matching**: Type partial names, scout finds matches\n- **AI Suggestions**: Scout learns from your navigation patterns\n- **Context Aware**: Suggests based on time and location\n- **Project Detection**: Recognizes project directories\n\n## Development\n\n1. Clone the repository\n2. Install development dependencies:\n```bash\nmake dev-setup\n```\n\n3. Run tests:\n```bash\nmake test\n```\n\n4. Build and install locally:\n```bash\nmake install\n```\n\n## License\n\nMIT License ",
"bugtrack_url": null,
"license": null,
"summary": "A modern, intuitive alternative to ls command with smart directory prediction",
"version": "0.11.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27bb2677c19aa9e557c67ef6ea8207d16d56141f04fd5dd8479b85d963dc607e",
"md5": "ebb7bb42346c6f8bc9ce4e47e80833e6",
"sha256": "6bfa8cab4281ae1288da5ce205a45da7479056eeb82149b6db4116eee47d5c1e"
},
"downloads": -1,
"filename": "scout_cli-0.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ebb7bb42346c6f8bc9ce4e47e80833e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12195,
"upload_time": "2025-01-08T18:41:28",
"upload_time_iso_8601": "2025-01-08T18:41:28.585260Z",
"url": "https://files.pythonhosted.org/packages/27/bb/2677c19aa9e557c67ef6ea8207d16d56141f04fd5dd8479b85d963dc607e/scout_cli-0.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0983447eefcb93683ae221f3ba7804743a1a5914afef70e84258b7ddfdfea9b9",
"md5": "2cf0c4ff99864733ef980f10db3dbf1a",
"sha256": "f0496a9af0771bdb40cf8cc3a13bae9d3b69bce668fea24c85688fee66939997"
},
"downloads": -1,
"filename": "scout_cli-0.11.0.tar.gz",
"has_sig": false,
"md5_digest": "2cf0c4ff99864733ef980f10db3dbf1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8765,
"upload_time": "2025-01-08T18:41:30",
"upload_time_iso_8601": "2025-01-08T18:41:30.682891Z",
"url": "https://files.pythonhosted.org/packages/09/83/447eefcb93683ae221f3ba7804743a1a5914afef70e84258b7ddfdfea9b9/scout_cli-0.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-08 18:41:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "scout-cli"
}
