{"id":22452162,"url":"https://github.com/ndeleforge/binocle","last_synced_at":"2025-03-27T12:28:44.229Z","repository":{"id":244985519,"uuid":"809069590","full_name":"ndeleforge/binocle","owner":"ndeleforge","description":"A CLI to quickly search anything anywhere.","archived":false,"fork":false,"pushed_at":"2025-03-22T11:45:44.000Z","size":70,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-22T12:27:01.592Z","etag":null,"topics":["binocle","duckduckgo","google","python","qwant","search","terminal"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ndeleforge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2024-06-01T15:46:27.000Z","updated_at":"2025-03-22T11:45:47.000Z","dependencies_parsed_at":"2024-06-18T21:14:30.831Z","dependency_job_id":"13ab15e1-66c9-44cb-a176-bf77d437ad96","html_url":"https://github.com/ndeleforge/binocle","commit_stats":null,"previous_names":["ndeleforge/binocle"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ndeleforge%2Fbinocle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ndeleforge%2Fbinocle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ndeleforge%2Fbinocle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ndeleforge%2Fbinocle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ndeleforge","download_url":"https://codeload.github.com/ndeleforge/binocle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245844118,"owners_count":20681643,"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":["binocle","duckduckgo","google","python","qwant","search","terminal"],"created_at":"2024-12-06T06:09:59.703Z","updated_at":"2025-03-27T12:28:44.222Z","avatar_url":"https://github.com/ndeleforge.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Header](/docs/images/header.png)\n\n\u003cdiv align=\"center\"\u003e\n\n[![GitHub license](https://img.shields.io/github/license/ndeleforge/binocle?style=for-the-badge)](https://github.com/ndeleforge/binocle/blob/main/LICENCE)\n![GitHub last commit](https://img.shields.io/github/last-commit/ndeleforge/binocle?style=for-the-badge)\n[![GitHub forks](https://img.shields.io/github/forks/ndeleforge/binocle?style=for-the-badge)](https://github.com/ndeleforge/binocle/network)\n[![GitHub stars](https://img.shields.io/github/stars/ndeleforge/binocle?style=for-the-badge)](https://github.com/ndeleforge/binocle/stargazers)\n\n\u003c/div\u003e\n\n\n# Table of contents\n* [Installation](#Installation)\n    * [Requirements](#Requirements)\n    * [Virtual environment](#Virtual-environment)\n        * [For Windows](#For-Windows)\n        * [For Linux](#For-Linux)\n    * [Launch](#Launch)\n* [Usage and examples](#Usage-and-examples)\n* [Engines in details](#Engines-in-details)\n\t* [Engines list](#Engines-list)\n    * [How to add an engine](#How-to-add-an-engine)\n* [Integration with terminal](#Integration-with-terminal)\n\n# Installation\n## Requirements\n\n- Python is required.\n- Download the last release OR launch the following command\n```BASH\ngit clone https://github.com/ndeleforge/binocle.git\n```\n- Move into the folder of Binocle\n```BASH\ncd binocle\n```\n\n## Virtual environment\n\nEven if it's optionnal, it is recommended to create a virutal environment.\n\n### For Windows\n```BASH\npy -m venv venv\nvenv\\Scripts\\activate\n```\n\n### For Linux\n```BASH\npython3 -m venv .venv\nsource .venv/bin/activate\n```\n\n## Launch\n- To install Python dependencies, launch the following commands\n```BASH\npip install -r requirements.txt\n```\n- Launch Binocle\n```BASH\ncd launcher\nbinocle\n```\n\n# Usage and examples\n\nBinocle has two ways of working :\n- Using default engine search\n```BASH\nbinocle \"hello it is a super research\"\n```\n\n- Specify an engine search\n```BASH\nbinocle d \"hello it is a super research\"\n```\n\nThose two commands do exactly the same thing.  \nIn the `/config/config.json` file, a *default engine* is defined. By default, it is Duckduckgo but you can change it to anything which exists as engine in the `/config/engines.json` file.\n\nTo summarize, if only one argument is used then the default engine will be used. However, to specify another search engine, the engine keyword must be used before the query search.\n\nMore examples : \n- Search *My Super Research* on **Duckduckgo** : \n```BASH\nbinocle d \"My Super Research\"\n```\n- Search *SomeYoutuber* on **Youtube** : \n```BASH\nbinocle yt SomeYoutuber\n```\n\nThere are also some optionnals arguments :\n- `-v` or `--version` : show version\n- `-h` or `--help` : show help\n- `-l` or `--list` : show engines list\n\n# Engines in details\n## Engines list\n\n| Keyword | Search on\n| ------------ | -------------------\n| alt | [Alternative To](https://alternativeto.net)\n| b | [Bing](https://www.bing.com)\n| ch | [Chocolatey](https://chocolatey.org)\n| d | [Duckduckgo](https://duckduckgo.com)\n| e | [Ecosia](https://www.ecosia.org)\n| g | [Google](https://google.com)\n| gi | [Github](https://github.com)\n| hltb | [HowLongTo Beat](https://howlongtobeat.com/)\n| li | [LinkedIn](https://www.linkedin.com)\n| meta | [Metacritic](https://metacritic.com)\n| mal | [MyAnimeList](https://myanimelist.net)\n| q | [Qwant](https://qwant.com)\n| re | [Reddit](https://www.reddit.com)\n| s | [Startpage](https://startpage.com)\n| so  | [StackOverflow](https://stackoverflow.com)\n| tw | [Twitch](https://twitch.com)\n| wi | [Wikipedia](https://wikipedia.org/wiki/)\n| yt | [Youtube](https://youtube.com)\n\n\n## How to add an engine\nAn **engine** is composed of **3** mandatory values :\n- *name* : must be a string and unique\n- *keyword* : must be a string and unique\n- *url* : must be a string and unique\n\nEdit the `/config/engines.json` file and follow this template : \n```JSON\n{\n    \"name\": \"My new engine\",\n    \"keyword\": \"new\",\n    \"url\": \"https://some.url\"\n}\n```\n\n# Integration with terminal\n\nBinocle can be launched throught a terminal with the command `binocle`. The idea is to add Binocle folder in your *PATH* global variable.  \nIt is doable for Windows with `binocle.bat` and Linux with `binocle.sh` which both are a shortcut for `binocle.py`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fndeleforge%2Fbinocle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fndeleforge%2Fbinocle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fndeleforge%2Fbinocle/lists"}