{"id":26674119,"url":"https://github.com/cs80-team/goolean","last_synced_at":"2026-06-10T09:31:41.178Z","repository":{"id":280733314,"uuid":"940285080","full_name":"CS80-Team/Goolean","owner":"CS80-Team","description":"A simple boolean information retrieval system with its own shell written in golang.","archived":false,"fork":false,"pushed_at":"2025-04-09T15:44:09.000Z","size":24570,"stargazers_count":9,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T06:53:38.888Z","etag":null,"topics":["go","golang","information-retrieval","shell"],"latest_commit_sha":null,"homepage":"","language":"Go","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/CS80-Team.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2025-02-27T23:11:01.000Z","updated_at":"2025-04-09T15:44:13.000Z","dependencies_parsed_at":"2025-03-18T13:28:19.382Z","dependency_job_id":null,"html_url":"https://github.com/CS80-Team/Goolean","commit_stats":null,"previous_names":["cs80-team/boolean-ir-system","cs80-team/booleanengine","cs80-team/goolean"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS80-Team%2FGoolean","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS80-Team%2FGoolean/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS80-Team%2FGoolean/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS80-Team%2FGoolean/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CS80-Team","download_url":"https://codeload.github.com/CS80-Team/Goolean/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248530591,"owners_count":21119595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["go","golang","information-retrieval","shell"],"created_at":"2025-03-26T02:17:32.172Z","updated_at":"2026-04-02T18:46:04.969Z","avatar_url":"https://github.com/CS80-Team.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Goolean\n\n## Overview\n\n\u003cb\u003eGoolean\u003c/b\u003e is a boolean model search engine that allows users to perform boolean queries on a dataset of documents (corpus). The system consists of an engine that processes and indexes documents and a shell that interact with the engine through a set of commands.\n\n## Features\n\n- **Command-line Shell**: Provides an interface to interact with the engine.\n- **Boolean Query Support**: Supports AND, OR, and NOT operations.\n- **Document Indexing**: Efficiently indexes documents for fast retrieval.\n- **Query Optimization**: Optimizes queries for better performance. (under construction)\n- **File Management**: Allows adding new files and listing indexed documents.\n\n## System Components\n\n1. **Shell**: Accepts user commands and communicates with the engine.\n3. **Engine**: Processes queries and retrieves relevant documents.\n   - **Loader**: Loads documents into the system.\n   - **Normalizer**: Prepares text by cleaning and standardizing it.\n   - **Indexer**: Indexes documents for searching.\n   - **Query Constructor**: Parses and builds the query.\n   - **Query Optimizer**: Improves query execution efficiency. (Under construction)\n\n## Commands\n\n- `query`: Query the engine for a keyword or a boolean expression\n  - Usage: `query \u003ckeyword\u003e | \u003cexpression\u003e`\n\n- `list`: List all documents, displayable by \u003cb\u003ename\u003c/b\u003e or/and \u003cb\u003epath\u003c/b\u003e or/and \u003cb\u003eID\u003c/b\u003e or/and \u003cb\u003eextension\u003c/b\u003e\nUse -sortby to sort results by name, path, id or extension\nUse -n to limit the number of results\nDefault fields order: `-id` `-name` `-path` `-ext`\nDefault sortby: `id`\nDefault limit: `all`\n  - Usage: `list \u003c-id | -name | -path | -ext\u003e [-n \u003climit\u003e] [-sortby \u003cname | path | id | -ext\u003e]`\n\n- `load`: Load a new document into the engine\n  - Usage: `load \u003cdocument_path\u003e`\n\n- `find`: Find a document by name or id.\nDisplay the document's id, name and path\nDefault search field: -name\n  - Usage: `find \u003c-id | -name\u003e \u003cvalue\u003e || find \u003cdocument_name\u003e`\n\n- `exit`: Exit the shell\n  - Usage: `exit`\n\n- `help`: List all available commands\n  - Usage: `help`\n\n- `clear`: Clear the screen\n  - Usage: `clear`\n\n- `open`: Open a document by ID in the default editor\n  - Usage: `open \u003cdocument_id\u003e`\n\n### Early Executed Commands (invoked after each command executed)\n\n- `engine-stats`: Displays the total number of documents and keys in the engine.\n  - Usage: `Reserved for the shell`\n\n## Installation\n\n1. Clone the repository:\n   ```sh\n   git clone https://github.com/CS80-Team/Goolean/\n   cd Goolean\n   ```\n2. Build the project:\n   ```sh\n   make build\n   cd bin/\n   ./goolean\n   ```\n\n## System Overview\n\n![System Overview](https://github.com/CS80-Team/Goolean/blob/master/docs/BIRSystemOverview.png)\n\n## Usage Example\n[![Demo video](./docs/demo.gif)](./docs/demo.mp4)\n\n## License\n![MIT License](LICENSE)\n\n## Contributors\n\n- [Omar Muhammad](https://github.com/OmarMGaber)\n- [Ahmed Ashraf](https://github.com/ahmed-ashraff)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcs80-team%2Fgoolean","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcs80-team%2Fgoolean","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcs80-team%2Fgoolean/lists"}