{"id":18303409,"url":"https://github.com/faltawy/lsql","last_synced_at":"2026-03-05T09:32:48.438Z","repository":{"id":244452592,"uuid":"815282506","full_name":"faltawy/lsql","owner":"faltawy","description":"(WIP) List your files with SQL like syntax, (Fun Project)","archived":false,"fork":false,"pushed_at":"2025-08-02T17:44:11.000Z","size":2763,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-20T06:40:37.521Z","etag":null,"topics":["files","rust","sql"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/faltawy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-06-14T18:56:27.000Z","updated_at":"2025-08-01T12:13:28.000Z","dependencies_parsed_at":"2025-04-05T15:41:27.729Z","dependency_job_id":null,"html_url":"https://github.com/faltawy/lsql","commit_stats":null,"previous_names":["ah7255703/lsql","faltawy/lsql"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/faltawy/lsql","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faltawy%2Flsql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faltawy%2Flsql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faltawy%2Flsql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faltawy%2Flsql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/faltawy","download_url":"https://codeload.github.com/faltawy/lsql/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faltawy%2Flsql/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30117710,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T08:19:04.902Z","status":"ssl_error","status_checked_at":"2026-03-05T08:17:37.148Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["files","rust","sql"],"created_at":"2024-11-05T15:25:32.079Z","updated_at":"2026-03-05T09:32:48.392Z","avatar_url":"https://github.com/faltawy.png","language":"Rust","readme":"# LSQL\n\nLSQL is a command-line utility that queries files and directories using SQL-like syntax.\n\n## Features\n\n- Query your filesystem using a familiar SQL-like syntax\n- Filter files and directories based on various properties (name, size, extension, etc.)\n- Interactive shell mode with command history\n- Colorized output\n- Configurable logging levels for debugging\n- Cross-platform (Windows, macOS, Linux)\n\n## Installation\n\n### Using Cargo\n\nThe easiest way to install LSQL is via Cargo, Rust's package manager:\n\n```bash\ncargo install lsql\n```\n\n### Using Cargo-Binstall\n\nFor faster installation without compilation, you can use [cargo-binstall](https://github.com/cargo-bins/cargo-binstall):\n\n```bash\n# Install cargo-binstall if you don't have it\ncargo install cargo-binstall\n\n# Install LSQL\ncargo binstall lsql\n```\n\n### From Source\n\nTo build from source, you'll need a Rust environment. If you don't have it yet, install it from [rustup.rs](https://rustup.rs/).\n\n```bash\n# Clone the repository\ngit clone https://github.com/faltawy/lsql.git\ncd lsql\n\n# Build and install\ncargo install --path .\n```\n\n### Pre-built Binaries\n\nYou can also download pre-built binaries from the [GitHub Releases page](https://github.com/faltawy/lsql/releases).\n\n## Usage\n\n### Basic Queries\n\nList all files and directories in the current directory:\n\n```bash\nlsql \"select * from .;\"\n```\n\nList files by selecting the type field:\n\n```bash\nlsql \"select type from .;\"\n```\n\nList specific fields including type:\n\n```bash\nlsql \"select name, type, size from .;\"\n```\n\n### Filtering with WHERE\n\nList all PNG files:\n\n```bash\nlsql \"select * from . where ext = \\\"png\\\";\"\n```\n\nList all files larger than 10MB:\n\n```bash\nlsql \"select * from . where size \u003e \\\"10mb\\\";\"\n```\n\nList all hidden files:\n\n```bash\nlsql \"select * from . where is_hidden = true;\"\n```\n\nCombined conditions:\n\n```bash\nlsql \"select * from . where ext = \\\"jpg\\\" and size \u003e \\\"1mb\\\";\"\n```\n\n### Interactive Shell\n\nStart the interactive shell:\n\n```bash\nlsql shell\n```\n\nIn shell mode, you can type queries directly without wrapping them in quotes:\n\n```\nlsql\u003e select * from .;\nlsql\u003e select type from /tmp where size \u003e \"1mb\";\n```\n\n### Options\n\n- `-n, --no-color`: Disable colored output\n- `-r, --recursive`: Enable recursive search\n- `-l, --log-level \u003cLEVEL\u003e`: Set the logging level [possible values: off, error, warn, info, debug, trace] (default: info)\n- `--help`: Show help information\n- `--version`: Show version information\n\n## Debugging\n\nYou can adjust the verbosity of the log output using the `--log-level` option:\n\n```bash\n# Show only errors\nlsql --log-level error \"select * from .;\"\n\n# Show detailed debug information\nlsql --log-level debug \"select type from .;\"\n\n# Maximum verbosity for troubleshooting\nlsql --log-level trace \"select * from . where ext = \\\"jpg\\\";\"\n```\n\n## SQL-like Grammar\n\n- `SELECT` - What to display\n  - `*`: All items\n  - Specific fields: e.g., `select name, size, ext, type from .;`\n\n- `FROM` - Where to search\n  - Any valid path on your system\n  - `.` for the current directory\n\n- `WHERE` - Conditions for filtering\n  - Properties: `name`, `path`, `size`, `ext`, `modified`, `created`, `is_hidden`, `type`, `permissions`\n  - Operators: `=`, `!=`, `\u003c`, `\u003c=`, `\u003e`, `\u003e=`, `like`, `contains`\n  - Size units: `b`, `kb`, `mb`, `gb`, `tb`\n  - Logical operators: `and`, `or`\n\n## Contributing\n\nInterested in contributing to LSQL? Check out the following resources:\n\n- [CONTRIBUTING.md](CONTRIBUTING.md): Guide on how to add new features\n- [Developer Guide](docs/developer_guide.md): Detailed explanation of the project architecture\n- [Examples](docs/examples/): Step-by-step guides for implementing specific features\n  - [Adding a LIMIT clause](docs/examples/add_limit_clause.md): Complete walkthrough of adding a LIMIT feature\n\nThe documentation covers how to:\n- Add new SQL statements and clauses\n- Implement new CLI commands\n- Add new filtering conditions\n- Follow the project's coding style\n\nWe welcome all contributions, from bug fixes to new features!\n\n## License\n\nMIT\n\n## Theming\n\nLSQL supports customizable themes to personalize the appearance of the output. The application comes with several built-in themes:\n\n- `default`: Standard theme with a clean, modern look\n- `dark`: Optimized for dark terminal backgrounds with bright colors\n- `light`: Optimized for light terminal backgrounds\n- `vibrant`: High-contrast theme with bright colors\n- `minimal`: Simplified theme with minimal styling\n\n### Using Themes\n\nSelect a theme using the `--theme` (or `-t`) option:\n\n```bash\nlsql --theme dark \"select * from .;\"\n```\n\nList all available themes:\n\n```bash\nlsql --list-themes\n```\n\n### Theme Management\n\nLSQL provides commands to manage themes:\n\n```bash\n# List all available themes\nlsql theme list\n\n# Set a theme\nlsql theme set --name dark\n\n# Create a new theme\nlsql theme create --name mytheme --base dark --description \"My custom theme\"\n```\n\nFor detailed information about creating and customizing themes, see the [Theme Guide](docs/themes.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaltawy%2Flsql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaltawy%2Flsql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaltawy%2Flsql/lists"}