{"id":20037395,"url":"https://github.com/nsh07/urbanite","last_synced_at":"2025-05-05T06:30:49.579Z","repository":{"id":208943522,"uuid":"493723914","full_name":"nsh07/urbanite","owner":"nsh07","description":"Command-line client for Urban Dictionary","archived":false,"fork":false,"pushed_at":"2024-08-25T10:39:41.000Z","size":1810,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-05T23:51:48.998Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C++","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/nsh07.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2022-05-18T15:35:52.000Z","updated_at":"2024-10-09T18:24:21.000Z","dependencies_parsed_at":"2023-11-24T06:37:44.042Z","dependency_job_id":"cb39375c-ef15-4b31-a2d8-8343ee65769d","html_url":"https://github.com/nsh07/urbanite","commit_stats":null,"previous_names":["nmrocks/urbanite","nsh07/urbanite"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nsh07%2Furbanite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nsh07%2Furbanite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nsh07%2Furbanite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nsh07%2Furbanite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nsh07","download_url":"https://codeload.github.com/nsh07/urbanite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252451372,"owners_count":21749926,"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":[],"created_at":"2024-11-13T10:19:18.946Z","updated_at":"2025-05-05T06:30:49.162Z","avatar_url":"https://github.com/nsh07.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Urbanite\n\nSearch words on Urban Dictionary at the comfort of your terminal.\n\n![Urbanite demo](media/urbanite-demo.gif)\n\n---\n\nUrbanite is a program for searching words and their definitions on [Urban Dictionary](https://www.urbandictionary.com/) within a terminal emulator/shell.\n\n---\n\n\u003c/div\u003e\n\n## Table of contents\n* [Usage and Features](#usage-and-features)\n* [Installation](#installation)\n  * [Linux](#linux)\n    * Desktop\n    * Android (Termux)\n  * [MacOS](#macos)\n  * [BSD/Other Unix-like](#bsdother-unix-like)\n  * [Windows](#windows)\n* License \u0026 Libraries\n\n## Usage and Features\n\nUsage: `urbanite ... [OPTIONS] ...`\n\nFor a basic word/phrase search, just run `urbanite your word or phrase here`. For more help about command line options, run `urbanite --help`. A basic overview of the available features is given here.\n\n* **Custom Figlet fonts -**\n  You can use your own figlet fonts to change the look of the output using the `-f (--font-file)` option. Urbanite comes bundled with a few font files by default and you can use more by using this option.\n* **Like/Dislike counts and stats -**\n  You can see the like and dislike counts, like to dislike ratio and percentage of likes of a definition\n  * **Custom symbols/emojis to denote the like/dislike counts -**\n    You can customize the symbols used to denote the like and dislike counts and ratios. Comes with 4 sets of symbols and a custom symbol option. Just use `-e (--emoji-style)`.\n\n## Installation\n\n### From release binaries\n\nBinaries are provided for Linux and Termux in tarballs on the [Releases page](https://github.com/NMrocks/urbanite/releases). Extract the tar archives and run `make install` in the extracted directory to install the binaries. You will need the libcurl package from your package manager becuase this program depends on the libcurl binaries.\n\n`.deb` archives are also available for Debian-based distros in [Releases](https://github.com/NMrocks/urbanite/releases).\n\n### From source\n\nTo compile from source, you must have [libcurl](https://curl.se/libcurl/) and [nlohmann's JSON library](https://json.nlohmann.me/) installed on the device the program is being compiled on. You will also need the libcurl package from your package manager becuase this program depends on the libcurl binaries.\n\n#### Linux\n\n* **Desktop**\n\n  On most desktop Linux distributions, the Makefile should work out of the box. Just run:\n  ```\n  $ make\n  ```\n  To compile, and then\n  ```\n  # make install\n  ```\n  To install Urbanite. The Makefile installs the binary by default to `/usr/local/bin` and the font files to `/usr/local/share/urbanite`, which should normally not be changed. If they need to be changed, you can pass your own prefix directory to `make` when compiling, for example `make prefix=/path/to/prefix`.\n\n* **Android (Termux)**\n\n  Termux's directory structure is the same as Linux but the prefix directory is different. To compile and install a working binary on Termux, you need to run:\n  ```sh\n  $ make prefix=$PREFIX # Compile\n  $ make install prefix=$PREFIX # Install\n  ```\n\n#### MacOS\n\nInstall instructions for desktop Linux will work fine on MacOS. Just `make` and then `make install`.\n\n#### BSD/Other Unix-like\n\nLinux instructions should work on other Unix-like systems like BSD-based OSs.\n\n#### Windows\n\nWindows is not supported yet.\n\n### Uninstall a from-source installation\n\nTo uninstall a from-source/tarball installation, simply run the install command you used but replace the `install` with an `uninstall`. For example,\n```sh\nmake install prefix=/my/path/to/prefix # Install command\n```\n```sh\nmake uninstall prefix=/my/path/to/prefix # Uninstall command\n```\n\n## License and Libraries\n\nThis program is licensed under the GNU General Public License v3 or later.\n\nThis program was made possible by the following libraries:\n\n* [Urban++](https://github.com/NMrocks/urban-plus-plus) by [Nishant Mishra](https://github.com/NMrocks) -\n  Also developed by me.\n\n  This library depends on:\n  * The [cURL](https://github.com/curl/curl/tree/master/include/curl) library by [Daniel Stenberg](https://github.com/bagder)\n  * The [JSON for Modern C++](https://github.com/nlohmann/json) library by [Niels Lohmann](https://github.com/nlohmann)\n\n* [Figlet For C++](https://github.com/srilakshmikanthanp/figlet) by [Sri Lakshmi Kanthan P](https://github.com/srilakshmikanthanp)\n  The library which makes the output more fancy\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnsh07%2Furbanite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnsh07%2Furbanite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnsh07%2Furbanite/lists"}